DERNIERE INFO : Mise à jour 3.0.5 disponible !
Inscription Connexion client

Plugins

IntroductionExtensions.png

Les plugins aussi nommées extension sont supportés par e-cms et permettent d’étendre les fonctionnalités des sites et du panel d’administration par tout ce qui puisse être possible en PHP.

Cela va de la création d’une gallérie d’images (comme celle inclue dans e-cms) à la gestion de factures et bien d’autres !

Pour accéder aux plugins dans l’interface d’administration, il suffit de se rendre dans la section « Extensions » accessible via le menu latéral où une liste complète des extensions installés est présente et selon la configuration de chaque extension, permet d’ouvrir le plugin sur le site et de l’administrer via le lien « Configuration ».

Structure de fichiers

Les plugins sous e-cms sont et doivent être placés dans le dossier plugins/ situé à la racine d’une instance d’e-cms où chaque dossiers à l’intérieur de celui-ci correspondant à un plugin spécifique.

Tout d’abord, il est important de noter que le nom de dossier d’un plugin correspond au nom interne de ce dernier et par conséquent son nom doit contenir des caractères alphanumériques uniquement.

A l’intérieur de d’un dossier de plugin, se trouve le seul fichier obligatoire et qui détermine la structure de tout le reste : config.xml.

Dans ce fichier xml, il est possible de renseigner diverses informations telles que le nom, le numéro de version, l’auteur et même l’icône alors que d’autres paramètres affectent directement le fonctionnement du plugin lui-même.

En effet, les informations présentes entre les balises <files> permettent de définir deux éléments facultatifs mais essentiels pour la majorité des plugins.
Le premier placé entre les balises <paneladmin> permet de définir le fichier qui est utilisé dans le panneau d’administration et donc pour administrer un plugin via cette interface.
Le second est quant à lui placé entre les balises <frontoffice> et permet de spécifier le fichier qui sera affiché sur le site aux visiteurs et utilisateurs dans le même titre qu’une page dynamique.

Pour avoir un exemple concret, vous pouvez consulter le fichier config.xml du plugin livré avec e-cms dans le dossier plugins/ecms_gallery/ ou alors télécharger une version en ligne.

Scripts et fonctionnement

Les fichiers renseignés dans config.xml, qu’ils soient affichés sur le site ou sur l’interface d’administration, partagent tous deux les mêmes propriétés, la seule différente étant que le fichier utilisé dans l’administration est bien entendu accessible uniquement aux utilisateurs autorisés.

Tout d’abord, et pour une raison de sécurité, ces fichiers doivent tous commencer par le code $ecms OR die(); qui est la seule exigence, tout le reste du code est étant libre pensez juste à placer les variables externes de votre plugin en global, les fichiers étant chargés dans une méthode interne.

De plus, ces fichiers comportent tous un accès pré-initialisé vers l’API via la variable $ecmsAPI ce qui permet de l’utiliser sans ce préoccuper de la clé d’API et donc de s’assurer de la compatibilité sur toutes les installations d’e-cms.

Au-delà de l’API, il est aussi possible d’utiliser dans ces fichiers deux variables appartenant à l’objet du plugin lui-même.
La première correspond au nom interne du plugin (et donc à son nom de dossier) est accessible tel que $this->internalName alors que la seconde correspond-elle au chemin relatif vers le plugin courant à partir de la racine de l’installation d’e-cms avec $this->internalPath.

Accueil > Documentation > Technique > Plugins