Comment créer un module Thelia - partie 1

Thelia permet d’étendre ses fonctionnalités grâce à l’ajout de plugins. Nous allons voir ici comment en réaliser un.

Il existe 4 types de plugins permettant d’étendre les fonctionnalités de Thelia :

1. Les plugins de type paiements permettant de rajouter des moyens de paiement.
2. Les plugins de type transports permettant de rajouter des modes de livraison.
3. Les plugins de type filtres permettant de rajouter des filtres.
4. Les plugins classiques, qui rassemblent tous les autres cas.

La liste des plugins téléchargeables est disponible ici : http://thelia.net/Plugins.html Thelia recense à peu près 250 plugins.

Pour illustrer la création d’un module nous allons partir du cahier des charges suivant :

1. Un commerçant souhaite pouvoir créer, modifier, supprimer des commentaires sur une fiche produit dans le back-office.
2. Les commentaires pourront être ou non validés.
3. Les commentaires validés seront affichés sur la fiche produit côté front office.

Le besoin énoncé, découvrons maintenant comment sont structurés les plugins.

Les plugins sont enregistrés dans le répertoire client/plugins de votre Thelia :

Comme vous pouvez le voir, nous avons ici le plugin chèque et le plugin colissimo avec tous les fichiers qu’ils contiennent. Un plugin c’est donc un dossier avec au minimum un fichier php ayant le même nom que le dossier, commençant par une majuscule.

Nous allons appeler notre plugin "commentaire". Créez donc un répertoire commentaire dans client/plugins ainsi que le fichier Commentaire.class.php :

La structure de notre plugin est en place. Il ne nous reste plus qu’à déclarer notre plugin, c’est à dire spécifier le type de plugin que nous développons (classiques, transports, paiements ou filtres).

La déclaration d’un plugin est en fait la déclaration d’une classe, qui hérite d’une des classes suivantes :

1. PluginsClassiques => pour les plugins Classiques
2. PluginsTransports => pour les plugins de transports
3. PluginsPaiements => Pour les plugins de paiements
4. FiltreBase => Pour les filtres

Notre plugin ne rentre pas dans le cadre des plugins transports, paiements ou filtres, il s’agit d’un plugin classique. Ouvrez donc votre fichier Commentaire.class.php à l’aide de votre éditeur préféré et déclarez la classe :

Pour l’instant nous appelons seulement le constructeur de la classe parente en lui spécifiant le nom du plugin. Ce n’est pas nécessaire de le faire si vous joignez la description de votre plugin au format XML, ce que nous allons voir dès à présent.

Le fichier plugin.xml est obligatoire. Il permet d’avoir des renseignements sur vous, la version du plugin, à partir de quelle version de Thelia votre plugin est compatible, si il est stable ou bien encore en développement, etc. Vous trouverez la documentation sur ce fichier ici : http://thelia.net/wiki/index.php/Structure_du_fichier_plugin.xml Voici un exemple :

Vous disposez maintenant aussi du fichier plugin.xml dans le répertoire de votre plugin.

Il est également préférable de rajouter de la documentation dans votre plugin indiquant ce qu’il fait et comment l’utiliser, en donnant des exemples d’utilisation. Nous allons donc rajouter un readme. Il vous suffit de créer un fichier Readme.txt. Pour l’instant il ne contient rien, nous le complèterons au fur et à mesure de nos développements.

Dans le prochain tutoriel nous verrons comment automatiser l’installation de notre plugin , c’est à dire créer automatiquement une table lors de l’activation du module. Nous développerons aussi les premières interfaces dans l’administration.

N’oubliez pas, vous pouvez consulter la documentation de Thelia à l’adresse suivante : http://thelia.net/wiki

Retrouvez la suite du tuto dans la partie 2 puis partie 3.