Add New API Methods

Kanboard uses the library JSON-RPC to handle API calls.

To add a new method, you can do something like this in your plugin:

$this->api->getProcedureHandler()->withCallback('my_method', function() {
    return 'foobar';
});

$this->container['api'] or $this->api exposes an instance of the object JsonRPC\Server.

Refer to the library documentation for more information.

Add New Console Commands

Kanboard uses the library Symfony Console to handle local command-line operations.

Kanboard exposes an instance of the object Symfony\Component\Console\Application via $this->cli. You can add new commands in your plugin:

$this->cli->add(new MyCommand());

Refer to the library documentation for more information.

Add New Task Filters

Since the task lexer is a factory that returns a new instance each time, you must extend the taskLexer container using the extend() method of Pimple.

Here is an example:

public function initialize()
{
    $this->container->extend('taskLexer', function($taskLexer, $c) {
        $taskLexer->withFilter(TaskBoardDateFilter::getInstance($c)->setDateParser($c['dateParser']));
        return $taskLexer;
    });
}

For the filter class implementation, there are several examples in the source code under the namespace Kanboard\Filter.

Application Hooks

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

Listen to Hook Events

In your initialize() method, call the on() method of the class Kanboard\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 Once

Some hooks can have only one listener, e.g., model:subtask-time-tracking:calculate:time-spent.

• Overrides time spent calculation when the sub-task timer is stopped.
• Arguments:
  • $user_id (integer)
  • $start (DateTime)
  • $end (DateTime)

Merge Hooks

“Merge hooks” act like the array_merge function. The hook callback must return an array, which will be merged with the default one.

Example to add events to 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
        });
    }
}

Example to override default values for task forms:

class Plugin extends Base
{
    public function initialize()
    {
        $this->hook->on('controller:task:form:default', function (array $default_values) {
            return empty($default_values['score']) ? array('score' => 4) : array();
        });
    }
}

List of merging hooks:

• controller:task:form:default

  • Overrides default values for task forms.
  • Arguments:
    • $default_values: current default values (array).

• controller:calendar:project:events

  • Adds 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:calendar:user:events

  • Adds 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 easily add a new stylesheet or JavaScript file to 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 Kanboard\Plugin\Css;

use Kanboard\Core\Plugin\Base;

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

List of asset hooks:

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

Reference Hooks

Reference hooks pass a variable by reference.

Example:

$this->hook->on('formatter:board:query', function (\PicoDb\Table &$query) {
    $query->eq(TaskModel::TABLE.'color_id', 'red');
});

The code above will show only tasks in red on the board.

List of reference hooks:

Template Hooks

Template hooks allow additional content in existing templates.

Example to add new content in the dashboard sidebar:

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

Example to attach a template with local variables:

$this->template->hook->attach('template:dashboard:sidebar', 'myplugin:dashboard/sidebar', [
    'variable' => 'foobar',
]);

Example to attach a template with a callable:

$this->template->hook->attachCallable('template:dashboard:sidebar', 'myplugin:dashboard/sidebar', function($hook_param1, $hook_param2) {
    return ['new_template_variable' => 'foobar']; // Inject a new variable into the plugin template
});

This call is usually defined in the initialize() method. The first argument is the 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 (lowerCamelCase).
• 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 names without a prefix are core templates.

List of template hooks: