Installation de plugins¶

manifest.json¶

Le fichier manifest.json est une déclaration du plugin à Phraseanet dans un format json. Voici le fichier manifest.json le plus minimal qui soit :

{
    "name": "mon-plugin",
    "description" : "Hello World plugin!"
}

De nombreuses propriétés peuvent être ajoutées à ce fichier, comme dans l’exemple ci-dessous :

{
    "name": "custom-connector",
    "description" : "A custom class connector",
    "keywords"    : ["connector"],
    "authors" : [
        {
            "name"     : "Author name",
            "homepage" : "http://example.com",
            "email"    : "email@example.com"
        }
    ],
    "homepage" : "http://example.com/project/example",
    "license"     : "MIT",
    "version"     : "0.1",
    "minimum-phraseanet-version": "4.0",
    "maximum-phraseanet-version": "4.1",
    "twig-paths": ["custom-twig-views"],
    "services" : [
        {
            "class": "Vendor\\PluginService"
        }
    ],
    "commands" : [
        {
            "class": "Vendor\\CustomCommand"
        }
    ],
    "extra" : {
        "custom-property" : "value"
    }
}

Détails des propriétés possibles pour le fichier manifest.json :

• name (requis, string) : Le nom du plugin. Doit être unique, en casse basse, ne peut contenir ni espace ni caractère spécial.
• description (requis, string) : Une description texte du plugin.
• keywords (array) : Un tableau de mot clés propres au plugin.
• authors (array) : Un tableau d’objets authors. L’objet authors accepte les propriétés “name”, “email” et “homepage”.
• homepage (string) : Un lien vers la page d’accueil du plugin.
• license (string) : Un identifiant de license tel que fourni par SPDX.
• version (string) : Un numéro de version au format semver.
• minimum-phraseanet-version (string) : Le numéro de version minimum de Phraseanet compatible (inclue).
• maximum-phraseanet-version (string) : Le numéro de version maximum de Phraseanet compatible (exclue).
• twig-paths (string) : Un tableau de chemin relatifs au plugin qui seront utilisés comme chemin pour charger les templates Twig (permet de personnaliser les templates Phraseanet par défaut).
• services : Un tableau d’objets de services de plugin à déclarer auprès de Phraseanet. Un service de plugin est configuré avec une propriété “class”.
• commands : Un tableau d’objets de commandes à déclarer auprès de Phraseanet Konsole. Une commande est configurée avec une propriété “class”.
• extra : Un objet de propriétés personnalisables par le développeur.

composer.json¶

Le fichier composer.json sert à gérer les dépendances PHP du plugin et créer un autoloader dédié.

{
    "name": "vendor/phraseanet-plugin-name",
    "description": "A Hello world plugin",
    "license" : "MIT",
    "autoload": {
        "psr-0": {
            "Vendor" : "src"
        }
    }
}

Le fichier précédent déclare que les sources du plugin sont chargées depuis le dossier src selon une structure PSR-0. Il est recommandé de consulter la documentation de composer pour plus d’informations.

Personalisation de service¶

Les services ajoutés via la propriété “services” du fichier manifest.json doivent implémenter l’interface Alchemy\Phrasea\Plugin\PluginProviderInterface.

Ajout d’une commande de console¶

Les commandes ajoutées via la propriété “commands” du fichier manifest.json doivent implémenter l’interface Alchemy\Phrasea\Command\CommandInterface. Une base simple est d’étendre la classe abstraite Alchemy\Phrasea\Command\Command.