From 8f3e2b2e5c62a6130f6c8867ab335fb4c1a32c5c Mon Sep 17 00:00:00 2001
From: Frederic Guillot <fred@kanboard.net>
Date: Fri, 4 Mar 2016 20:10:34 -0500
Subject: Helper refactoring

---
 doc/plugin-helpers.markdown | 40 ++++++++++++++++++++++++++++++++++++++++
 doc/plugins.markdown        |  1 +
 2 files changed, 41 insertions(+)
 create mode 100644 doc/plugin-helpers.markdown

(limited to 'doc')

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)
-- 
cgit v1.2.3