blob: f5ace73c152539f1aa1ac54134f7a82e37f01ce9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
Metadata
========
You can attach metadata for each project, task, user or for the whole application.
Metadata are custom fields, it's a key/value table.
For example your plugin can store external information for a task or new settings for a project.
Basically that allow you to extend the default fields without having to create new tables.
Attach metadata to tasks and remove them
------------------------
```php
// Return a dictionary of metadata (keys/values) for the $task_id
$this->taskMetadata->getAll($task_id);
// Get a value only for a task
$this->taskMetadata->get($task_id, 'my_plugin_variable', 'default_value');
// Return true if the metadata my_plugin_variable exists
$this->taskMetadata->exists($task_id, 'my_plugin_variable');
// Create or update metadata for the task
$this->taskMetadata->save($task_id, ['my_plugin_variable' => 'something']);
// Remove a metadata from a project
$this->projectMetadata->remove($project_id, my_plugin_variable);
```
Metadata types
--------------
- TaskMetadata: `$this->taskMetadata`
- ProjectMetadata: `$this->projectMetadata`
- UserMetadata: `$this->userMetadata`
- Settings/Config: `$this->config`
Notes
-----
- Always prefix the metadata name with your plugin name
|
