diff options
author | Frédéric Guillot <fred@kanboard.net> | 2018-04-06 10:54:58 -0700 |
---|---|---|
committer | Frédéric Guillot <fred@kanboard.net> | 2018-04-06 10:54:58 -0700 |
commit | 0b306fa60ad84ea077111e0ff7b59208ba7bc8a3 (patch) | |
tree | 5d8941b5950ede2db8ca3fba0213792db0f07a50 /doc/en_US/plugin-automatic-actions.markdown | |
parent | ac11220a1aa7ae30b8827d9bbf221888d3edd0a7 (diff) |
Move documentation to https://docs.kanboard.org/
Diffstat (limited to 'doc/en_US/plugin-automatic-actions.markdown')
-rw-r--r-- | doc/en_US/plugin-automatic-actions.markdown | 60 |
1 files changed, 0 insertions, 60 deletions
diff --git a/doc/en_US/plugin-automatic-actions.markdown b/doc/en_US/plugin-automatic-actions.markdown deleted file mode 100644 index b309fac9..00000000 --- a/doc/en_US/plugin-automatic-actions.markdown +++ /dev/null @@ -1,60 +0,0 @@ -Adding Automatic Actions -======================== - -Adding a new automatic action is pretty simple. - -Creating a new action ---------------------- - -Your automatic action must inherit of the class `Kanboard\Action\Base`. -Several abstract methods must be implemented by yourself: - -| Method | Description | -|-------------------------------------|------------------------------------------------------------------| -| `getDescription()` | Description visible in the user interface | -| `getCompatibleEvents()` | Get the list of compatible events | -| `getActionRequiredParameters()` | Get the required parameter for the action (defined by the user) | -| `getEventRequiredParameters()` | Get the required parameter for the event | -| `doAction(array $data)` | Execute the action, must return true on success | -| `hasRequiredCondition(array $data)` | Check if the event data meet the action condition | - -Your automatic action is identified in Kanboard by using the absolute class name with the name space included. - -Adding new events ------------------ - -The list of application events is available in the class `Kanboard\Core\Event\EventManager::getAll()`. -However, if your plugin fires new events, you can register these events like that: - -```php -$this->actionManager->getAction('\Kanboard\Plugin\MyPlugin\MyActionName')->addEvent('my.event', 'My event description'); -``` - -You can extend the list of compatible events of existing actions by using the same method. - -Registering the action ----------------------- - -You have to call the method `register()` from the class `Kanboard\Core\Action\ActionManager`: - -```php -<?php - -namespace Kanboard\Plugin\AutomaticAction; - -use Kanboard\Core\Plugin\Base; -use Kanboard\Plugin\AutomaticAction\Action\TaskRename; - -class Plugin extends Base -{ - public function initialize() - { - $this->actionManager->register(new TaskRename($this->container)); - } -} -``` - -Example -------- - -- [Automatic Action example](https://github.com/kanboard/plugin-example-automatic-action) |