Plugins

A Kimai plugin is from a technical perspective only a Symfony bundle, with some minor modifications.

Within the external communication it is called plugin instead of bundle, as this is the wording most users know.

Kimai plugins vs. pure Symfony bundles

The reason for using a slightly different approach than the proposed Symfony way is the recommended way to install and update Kimai with Git and Composer.

If you would install a bundle using composer, you would end up with a “dirty git status” and run into problems when performing the next update (with changes in: bundles.php, composer.json, composer.lock, symfony.lock).

The application Kernel was slightly modified to allow dynamic plugin and route loading, to prevent this from happening.

Plugin location

Kimai plugins are stored in var/plugins/, for example var/plugins/YourBundle/. The contents in var/plugins/* are listed in the .gitignore file to prevent update problems.

Plugin installation

Due to the changed plugin location, installation should be done with git clone (recommended way) or with a copy task, but composer can be used as well (leading to the mentioned update problems).

Difference between Kimai plugin and Symfony bundle

There are some differences to Symfony bundles, which were added to prevent the above mentioned update problems:

  • Kimai plugins are stored in var/plugins/ instead of vendor/
  • Kimai plugins are loaded automatically in each environment (don’t modify config/bundles.php)
  • Routes are automatically loaded with the search pattern:
    var/plugins/YourBundle/Resources/config/routes.{php,xml,yaml,yml}
  • Your Bundle class needs to be namespaced with the vendor segment KimaiPlugin
  • Your Bundle must implement App\Plugin\PluginInterface

The namespace is pre-registered in composer with the vendor segment locked to KimaiPlugin, pointing to var/plugins/ to prevent that users have to dump a new autoloader after installing a plugin.

Directory structure

The minimal directory structure must look like this:

/kimai/var/plugins/
├── YourBundle
│   ├── YourBundle.php
│   ├── composer.json
|   └ ... more files and directories follow here ... 

Bundle class

And the bundle class looking like this:

namespace KimaiPlugin\YourBundle;

use App\Plugin\PluginInterface;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\HttpKernel\Bundle\Bundle;

class YourBundle extends Bundle implements PluginInterface
{
}

Even though its called plugin in Kimai, the namespace and classes still need to follow the official Symfony bundle naming conventions.

composer.json

Your plugin needs to ship a composer.json, even if it is not used for installation. Kimai will read values from it for extended information in the plugins admin panel.

A minimal composer.json could look like this:

{
    "name": "keleo/custom-css-bundle",
    "description": "A Kimai 2 plugin which allows to edit custom CSS rules through an administration screen.",
    "homepage": "https://www.kimai.org/store/keleo-css-custom-bundle.html",
    "type": "kimai-plugin",
    "require": {
        "kimai/kimai2-composer": "*"
    },
    "extra": {
        "kimai": {
            "require": "0.9",
            "version": "1.0",
            "name": "CustomCSSBundle"
        }
    }
}

The type (kimai-plugin) )is required for proper installation if composer is used, as well as the require package kimai/kimai2-composer. The homepage will be used for a backlink in the admin panel.

The values in the extra.kimai section are used for:

  • require - the required (minimal) Kimai which is needed for this plugin
  • version - the version of this plugin
  • name - the name of the plugin, used as target directory name of your bundle

Data storage

When your plugin wants to store files, don’t use your plugin directory or concat the directory yourself, but use the ServiceContainer parameter %kimai.data_dir%. This is currently pointing to var/data/ and also protected from the above mentioned update problems via .gitignore.

As this could change in the future, always inject the data directory instead of finding a place yourself:

services:
    KimaiPlugin\YourBundle\MyController:
        arguments:
            $dataDirectory: "%kimai.data_dir%"

There is another parameter called %kimai.plugin_dir%, which is pointing to the base directory of all plugins.

Example plugin

Please have a look at the CustomCSSBundle which serves as bundle demo:

  • A bundle with an extension to load service definitions
  • Additional routes
  • An admin controller with form usage, flash messages and an additional view
  • EventSubscriber to extend the navigation
  • Translations
  • Data storage in %kimai.data_dir%

List your plugin in the Marketplace

If you created a plugin or any other kind of software around Kimai 2 which you want to see listed in the Marketplace, head over to the Marketplace documentation to find out how.