diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/plugin-helpers.markdown | 40 | ||||
-rw-r--r-- | doc/plugins.markdown | 1 |
2 files changed, 41 insertions, 0 deletions
diff --git a/doc/plugin-helpers.markdown b/doc/plugin-helpers.markdown new file mode 100644 index 00000000..8cc6b42a --- /dev/null +++ b/doc/plugin-helpers.markdown @@ -0,0 +1,40 @@ +Registering new helpers +======================= + +Helper skeleton: + +```php +<?php + +namespace Kanboard\Plugin\MyPlugin\Helper\MyHelper; + +use Kanboard\Core\Base; + +class MyHelper extends Base +{ + public function doSomething() + { + return 'foobar'; + } +} +``` + +Register your helper class: + +```php +$this->helper->register('myHelper', '\Kanboard\Plugin\MyPlugin\Helper\MyHelper'); +``` + +Using your helper from a template: + +```php +<p> + <?= $this->myHelper->doSomething() ?> +</p> +``` + +Using your helper from another class: + +```php +$this->helper->myHelper->doSomething(); +``` diff --git a/doc/plugins.markdown b/doc/plugins.markdown index 55575612..e38c887f 100644 --- a/doc/plugins.markdown +++ b/doc/plugins.markdown @@ -13,6 +13,7 @@ Plugin creators should specify explicitly the compatible versions of Kanboard. I - [Override default application behaviors](plugin-overrides.markdown) - [Add schema migrations for plugins](plugin-schema-migrations.markdown) - [Custom routes](plugin-routes.markdown) +- [Add helpers](plugin-helpers.markdown) - [Add mail transports](plugin-mail-transports.markdown) - [Add notification types](plugin-notifications.markdown) - [Add automatic actions](plugin-automatic-actions.markdown) |