diff options
author | Frederic Guillot <fred@kanboard.net> | 2016-06-01 20:21:26 -0400 |
---|---|---|
committer | Frederic Guillot <fred@kanboard.net> | 2016-06-01 20:21:26 -0400 |
commit | ca87b1b60f9b4b49c80920e5009d6fbe4e3fb514 (patch) | |
tree | 7e70d2dd7e9466571146a47229965fcb043dff82 /doc/plugin-metadata.markdown | |
parent | b0a31b168f41cf4b4e88b018747916992d9e5830 (diff) |
Update documentation
Diffstat (limited to 'doc/plugin-metadata.markdown')
-rw-r--r-- | doc/plugin-metadata.markdown | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/doc/plugin-metadata.markdown b/doc/plugin-metadata.markdown index f5ace73c..49da0ac1 100644 --- a/doc/plugin-metadata.markdown +++ b/doc/plugin-metadata.markdown @@ -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 ----- |