summaryrefslogtreecommitdiff
path: root/doc/plugin-metadata.markdown
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plugin-metadata.markdown')
-rw-r--r--doc/plugin-metadata.markdown9
1 files changed, 6 insertions, 3 deletions
diff --git a/doc/plugin-metadata.markdown b/doc/plugin-metadata.markdown
index a01b0ddc..1f4bfa2b 100644
--- a/doc/plugin-metadata.markdown
+++ b/doc/plugin-metadata.markdown
@@ -4,10 +4,10 @@ Metadata
You can attach metadata for each project, task and user.
Metadata are custom fields, it's a key/value table.
-By example your plugin can store external information for a task or new settings for a project.
-Basically that allow you to exend the default fields without having to create new tables.
+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
+Attach metadata to tasks and remove them
------------------------
```php
@@ -23,6 +23,9 @@ $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