AS1024/Kanboard-Prod
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
Frederic Guillot
2016-06-01 20:21:26 -04:00
parent b0a31b168f
commit ca87b1b60f
5 changed files with 19 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
doc/plugin-metadata.markdown
View File

@@ -13,28 +13,28 @@ Attach metadata to tasks and remove them
```php
// Return a dictionary of metadata (keys/values) for the $task_id
$this->taskMetadata->getAll($task_id);
$this->taskMetadataModel->getAll($task_id);
// Get a value only for a task
$this->taskMetadata->get($task_id, 'my_plugin_variable', 'default_value');
$this->taskMetadataModel->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');
$this->taskMetadataModel->exists($task_id, 'my_plugin_variable');
// Create or update metadata for the task
$this->taskMetadata->save($task_id, ['my_plugin_variable' => 'something']);
$this->taskMetadataModel->save($task_id, ['my_plugin_variable' => 'something']);
// Remove a metadata from a project
$this->projectMetadata->remove($project_id, my_plugin_variable);
$this->projectMetadataModel->remove($project_id, my_plugin_variable);
```
Metadata types
--------------
- TaskMetadata: `$this->taskMetadata`
- ProjectMetadata: `$this->projectMetadata`
- UserMetadata: `$this->userMetadata`
- Settings/Config: `$this->config`
- TaskMetadata: `$this->taskMetadataModel`
- ProjectMetadata: `$this->projectMetadataModel`
- UserMetadata: `$this->userMetadataModel`
- Settings/Config: `$this->configModel`
Notes
-----