Helper refactoring

This commit is contained in:
Frederic Guillot
2016-03-04 20:10:34 -05:00
parent f32507d423
commit 8f3e2b2e5c
141 changed files with 562 additions and 445 deletions

View File

@@ -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();
```

View File

@@ -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)