kanboard_ynh/sources/doc/plugins.markdown

Plugin Development

Note: The plugin API is considered alpha at the moment.

Plugins are useful to extend the core functionalities of Kanboard, adding features, creating themes or changing the default behavior.

Plugin creators should specify explicitly the compatible versions of Kanboard. Internal code of Kanboard may change over the time and your plugin must be tested with new versions.

Directory structure

Plugins are stored in the plugins subdirectory. An example of a plugin directory structure:

plugins
└── Budget            <= Plugin name
    ├── Asset         <= Javascript/CSS files
    ├── Controller
    ├── LICENSE       <= Plugin license
    ├── Locale
    │   ├── fr_FR
    │   ├── it_IT
    │   ├── ja_JP
    │   └── zh_CN
    ├── Model
    ├── Plugin.php    <= Plugin registration file
    ├── README.md
    ├── Schema        <= Database migrations
    ├── Template
    └── Test          <= Unit tests

Only the registration file Plugin.php is required. Other folders are optionals.

The first letter of the plugin name must be capitalized.

Plugin registration file

Kanboard will scan the directory plugins and load automatically everything under this directory. The file Plugin.php is used to load and register the plugin.

Example of Plugin.php file (plugins/Foobar/Plugin.php):

<?php

namespace Plugin\Foobar;

use Core\Plugin\Base;

class Plugin extends Plugin\Base
{
    public function initialize()
    {
        $this->template->hook->attach('template:layout:head', 'theme:layout/head');
    }
}

This file should contains a class Plugin defined under the namespace Plugin\Yourplugin and extends Core\Plugin\Base.

The only required method is initialize(). This method is called for each request when the plugin is loaded.

Plugin methods

Available methods from Core\Plugin\Base:

• initialize(): Executed when the plugin is loaded
• getClasses(): Return all classes that should be stored in the dependency injection container
• on($event, $callback): Listen on internal events
• getPluginName(): Should return plugin name
• getPluginAuthor(): Should return plugin author
• getPluginVersion(): Should return plugin version
• getPluginDescription(): Should return plugin description
• getPluginHomepage(): Should return plugin Homepage (link)

Your plugin registration class also inherit from Core\Base, that means you can access to all classes and methods of Kanboard easily.

This example will fetch the user #123:

$this->user->getById(123);

Application Hooks

Hooks can extend, replace, filter data or change the default behavior. Each hook is identified with a unique name, example: controller:calendar:user:events

Listen on hook events

In your initialize() method you need to call the method on() of the class Core\Plugin\Hook:

$this->hook->on('hook_name', $callable);

The first argument is the name of the hook and the second is a PHP callable.

Hooks executed only one time

Some hooks can have only one listener:

model:subtask-time-tracking:calculate:time-spent

• Override time spent calculation when subtask timer is stopped
• Arguments:
  • $user_id (integer)
  • $start (DateTime)
  • $end (DateTime)

model:subtask-time-tracking:calendar:events

• Override subtask time tracking events to display the calendar
• Arguments:
  • $user_id (integer)
  • $events (array)
  • $start (string, ISO-8601 format)
  • $end (string, ISO-8601 format)

Merge hooks

"Merge hooks" act in the same way as the function array_merge. The hook callback must return an array. This array will be merged with the default one.

Example to add events in the user calendar:

class Plugin extends Base
{
    public function initialize()
    {
        $container = $this->container;

        $this->hook->on('controller:calendar:user:events', function($user_id, $start, $end) use ($container) {
            $model = new SubtaskForecast($container);
            return $model->getCalendarEvents($user_id, $end); // Return new events
        });
    }
}

List of merge hooks:

controller📆project:events

• Add more events to the project calendar
• Arguments:
  • $project_id (integer)
  • $start Calendar start date (string, ISO-8601 format)
  • $end Calendar` end date (string, ISO-8601 format)

controller📆user:events

• Add more events to the user calendar
• Arguments:
  • $user_id (integer)
  • $start Calendar start date (string, ISO-8601 format)
  • $end Calendar end date (string, ISO-8601 format)

Asset Hooks

Asset hooks can be used to add easily a new stylesheet or a new javascript file in the layout. You can use this feature to create a theme and override all Kanboard default styles.

Example to add a new stylesheet:

<?php

namespace Plugin\Css;

use Core\Plugin\Base;

class Plugin extends Base
{
    public function initialize()
    {
        $this->hook->on('template:layout:css', 'plugins/Css/skin.css');
    }
}

List of asset Hooks:

• template:layout:css
• template:layout:js

Template hooks

Template hooks allow to add new content in existing templates.

Example to add new content in the dashboard sidebar:

$this->template->hook->attach('template:dashboard:sidebar', 'myplugin:dashboard/sidebar');

This call is usually defined in the initialize() method. The first argument is name of the hook and the second argument is the template name.

Template names prefixed with the plugin name and colon indicate the location of the template.

Example with myplugin:dashboard/sidebar:

• myplugin is the name of your plugin (lowercase)
• dashboard/sidebar is the template name
• On the filesystem, the plugin will be located here: plugins\Myplugin\Template\dashboard\sidebar.php
• Templates are written in pure PHP (don't forget to escape data)

Template name without prefix are core templates.

List of template hooks:

• template:dashboard:sidebar
• template:config:sidebar
• template:export:sidebar
• template:layout:head
• template:layout:top
• template:layout:bottom
• template:project:dropdown
• template:project-user:sidebar
• template:task:sidebar:information
• template:task:sidebar:actions
• template:user:sidebar:information
• template:user:sidebar:actions

Other template hooks can be added if necessary, just ask on the issue tracker.

Template overrides

Any templates defined in the core can be overrided. By example, you can redefine the default layout or change email notifications.

Example of template override:

$this->template->setTemplateOverride('header', 'theme:layout/header');

The first argument is the original template name and the second argument the template to use as replacement.

Listen on events

Kanboard use internal events and your plugin can listen and perform actions on these events.

$this->on('session.bootstrap', function($container) {
    // Do something
});

• The first argument is the event name
• The second argument is a PHP callable function (closure or class method)

Extend Automatic Actions

To define a new automatic action with a plugin, you just need to call the method extendActions() from the class Model\Action, here an example:

<?php

namespace Plugin\AutomaticAction;

use Core\Plugin\Base;

class Plugin extends Base
{
    public function initialize()
    {
        $this->action->extendActions(
            '\Plugin\AutomaticAction\Action\SendSlackMessage', // Use absolute namespace
            t('Send a message to Slack when the task color change')
        );
    }
}

• The first argument of the method extendActions() is the action class with the complete namespace path. The namespace path must starts with a backslash otherwise Kanboard will not be able to load your class.
• The second argument is the description of your automatic action.

The automatic action class must inherits from the class Action\Base and implements all abstract methods:

• getCompatibleEvents()
• getActionRequiredParameters()
• getEventRequiredParameters()
• doAction(array $data)
• hasRequiredCondition(array $data)

For more details you should take a look to existing automatic actions or this plugin example.

Extend ACL

Kanboard use an access list for privilege separations. Your extension can add new rules:

$this->acl->extend('project_manager_acl', array('mycontroller' => '*'));

• The first argument is the ACL name
• The second argument are the new rules
  • Syntax to include only some actions: array('controller' => array('action1', 'action2'))
  • Syntax to include all actions of a controller: array('controller' => '*')
  • Everything is lowercase

List of ACL:

• public_acl: Public access without authentication
• project_member_acl: Project member access
• project_manager_acl: Project manager access
• project_admin_acl: Project Admins
• admin_acl: Administrators

Plugin Translations

Plugin can be translated in the same way the rest of the application. You must load the translations yourself when the session is created:

$this->on('session.bootstrap', function($container) {
    Translator::load($container['config']->getCurrentLanguage(), __DIR__.'/Locale');
});

The translations must be stored in plugins/Myplugin/Locale/xx_XX/translations.php.

Override HTTP Content Security Policy

If you would like to replace the default HTTP Content Security Policy header, you can use the method setContentSecurityPolicy():

<?php

namespace Plugin\Csp;

class Plugin extends \Core\Plugin\Base
{
    public function initialize()
    {
        $this->setContentSecurityPolicy(array('script-src' => 'something'));
    }
}

Dependency Injection Container

Kanboard use Pimple, a simple PHP Dependency Injection Container. However, Kanboard can register any class in the container easily.

Those classes are available everywhere in the application and only one instance is created.

Here an example to register your own models in the container:

public function getClasses()
{
    return array(
        'Plugin\Budget\Model' => array(
            'HourlyRate',
            'Budget',
        )
    );
}

Now, if you use a class that extends from Core\Base, you can access directly to those class instance:

$this->hourlyRate->remove(123);
$this->budget->getDailyBudgetBreakdown(456);

// It's the same thing as using the container:
$this->container['hourlyRate']->getAll();

Keys of the containers are unique across the application. If you override an existing class you will change the default behavior.

Schema migrations

Kanboard execute database migrations automatically for you. Migrations must be stored in a folder Schema and the filename must be the same as the database driver:

Schema
├── Mysql.php
├── Postgres.php
└── Sqlite.php

Each file contains all migrations, here an example for Sqlite:

<?php

namespace Plugin\Something\Schema;

const VERSION = 1;

function version_1($pdo)
{
    $pdo->exec('CREATE TABLE IF NOT EXISTS something (
        "id" INTEGER PRIMARY KEY,
        "project_id" INTEGER NOT NULL,
        "something" TEXT,
        FOREIGN KEY(project_id) REFERENCES projects(id) ON DELETE CASCADE
    )');
}

• The constant VERSION is the last version of your schema
• Each function is a migration version_1(), version_2(), etc...
• A PDO instance is passed as first argument
• Everything is executed inside a transaction, if something doesn't work a rollback is performed and the error is displayed to the user

Kanboard will compare the version defined in your schema and the version stored in the database. If the versions are different, Kanboard will execute one by one each migration until to reach the last version.

Examples of plugins

• Budget planning
• User timetable
• Subtask Forecast
• Automatic Action example
• Theme plugin example
• CSS plugin example