ITSM-NG est doté d’un puissant moteur de plugin qui permet de modifier la majorité des pages du logiciel et d’en créer. Les méthodes de création d’un plugin sont assez libre mais nécessite de suivre quelques standards. (Cette page est liée a un repo github contenant un exemple minimal)
L’arborescence
L’arborescence des plugins ITSM-NG se présente de la sorte:
MyPlugin/
┣ front/
┣ inc/
┣ locales/
┣ */
┣ hook.php
┗ setup.php
Les dossiers
- front/ contient les fichiers contenant les pages et formulaires du plugin.
- inc/ contient les fichier contenant les classes et la logique du plugin.
- locales/ contient les fichier de traduction (*.po, *.mo).
- Vous avez la liberté d’ajouter d’autres dossiers en veillant a garder l’arborescence compréhensible.
Les fichiers
setup.php
setup.php défini la fiche d’identité et les vérifications d’installation du plugin. il doit au moins contenir ces cinq fonctions ({MONPLUGIN} étant le nom de votre plugin):
plugin_version_{MONPLUGIN}(): array: La fiche d’identité du plugin.plugin_init_{MONPLUGIN}(): void: pour initialiser les hooks du plugin.plugin_{MONPLUGIN}_check_prerequisites(): bool: Vérification des dépendances nécessaire au plugin AVANT l’installation.plugin_{MONPLUGIN}_check_config($verbose = false): bool: Vérification de la configuration nécessaire au plugin AVANT l’installation. Il est aussi encouragé de charger la version du plugin dans une constance{MONPLUGIN_VERSION}
hook.php
hook.php contient la définition des hooks du plugin. il doit au moins contenir ces deux fonctions ({MONPLUGIN} étant le nom de votre plugin):
plugin_{MONPLUGIN}_install(): bool: créer les bases de données du plugin et effectue les étapes nécessaire a son l’installation.plugin_{MONPLUGIN}_uninstall(): bool: supprime les bases de données du plugin et effectue les étapes nécessaire a son l’installation.
Convention de nommage
Le système de plugin est sensible au nommage des fichier et des classes, ainsi, un fichier qui s’appelle {NOMDUFICHIER}.php ou {NOMDUFICHIER}.*.php doit contenir une classe qui se nomme Plugin{NOMDUPLUGIN}{NOMDUFICHIER} Sinon, elle ne sera pas detectée par le logiciel.
Les tables créées par le plugin doivent toutes avoir un nom commencant par glpi_plugin_{NOMDUPLUGIN}_
Configuration
Pour customiser le fil d’ariane et les boutons du header de chaque pages, il est possible d’ajouter dans leur header un fichier de configuration (/inc/config.class.php) Celui-ci peut aussi encapsuler le fichier front lors de l’ajout d’un champ dans la barre de navigation par exemple (comme ici)
Ce fichier contient en particulier la fonction getMenuContent qui retourne un objet contenant:
- le titre de la page
- la page a rediriger
- l’icone a afficher dans le champ ou dans le fil d’ariane
Gestion des droits
Pour gérer les droits d’un plugin, celui-ci doit (créer une table de profile nommée glpi_plugin_{NOMDUPLUGIN}_profiles dans le fichier hook.php)[/hook.php#L38]. Le plugin doit aussi contenir un fichier (/inc/profile.class.php)[/inc/profile.class.php] qui contient la logique d’attribution des droits, le code dans le repo d’exemple donne les droit de modifications a celui qui installe le plugin, qu’il peut alors gérer dans la partie administration>profiles>{NOMDUPLUGIN} grâce aux fonctions:
- (
function getTabNameForItem(CommonGLPI $item, $withtemplate=0))[/inc/profile.class.php#L112] - (
static function displayTabContentForItem(CommonGLPI $item, $tabnum=1, $withtemplate=0))[/inc/profile.class.php#L128] - (
function showForm($profiles_id = 0, $openform = true, $closeform = true))[/inc/profile.class.php#L171]
Traduction
Les fichiers de traductions sont dans des fichiers .mo .po et .pot Cette partie peut être (automatisé avec Poedit)[PHP and Javascript Internationalization using Gettext and Poedit - pontikis.net]