jeudi 30 décembre 2010

Mon premier Module Joomla #2

L’arborescence


Joomla est un CMS très puissant et surtout flexible grâce à son gestion de modules. Vous pouvez vous informer des possibilités de Joomla sur le site :
www.joomla.fr

Je me suis largement basé sur cet exemple pour le module Joomla :
http://docs.joomla.org/How_to_create_a_module

et voici le module finalisé
http://sites.google.com/site/pint2stone/mod_server_health.zip

Un module Joomla demande une arborescence assez rigoureuse. Je n’ai pas su si c’était obligatoire mais en tout cas, c’est des bonnes méthodes a prendre pour vous faciliter la vie plus tard.

On créé en premier un dossier modules (il ne nous servira pas mais c'est pour l'organisation)
la dedans on aura un dossier pour chaque module avec le nom final de notre module sans espace. il faut également qu'il commence par "mod_" pour respecter les appellations dans Joomla!. enfin dans ce dossier mod_... on place un dossier tmpl pour stocker nos fichiers de mise en page (template)


Les fichiers dans mod_server_health



Et les fichiers dans tmpl



Les index.html sont des fichiers vides, ils ont pour but de sécuriser le dossier. Si malencontreusement, quelqu’un arrive à faire pointer son navigateur sur votre dossier, par défaut il voit la liste de tous les fichiers. Le fait de mettre un index.html empêche ce fonctionnement et affichera cette page par défaut.


Les deux fichiers ini sont en fait des fichiers de langues. Tout le texte à afficher sera placé dans ces fichiers. Ensuite, en fonction de la langue, Joomla va chercher le texte correspondant. Ici j’ai créé le module en anglais (en-GB) et français (fr-FR).

Le fichier helper.php sert a stocker les fonctions php qu’on a créer (pour nous ca sera notre « PingDomaine ») et le fichier mod_server_health.php fera tout le traitement.

Mod_server_health.xml est le fichier de configuration nécessaire pour l’installation du module dans Joomla. C’est lui qui va dire a joomla les fichiers présents et les paramètres a créer.

Les fichiers dans tmpl (ici default.php) sont les fichiers de mise en page (Template) qui feront l’affichage final.

Chose important : on remarquera que les fichiers et le dossier parent ont tos le même nom, mod_server_health. Il faut respecter cette méthode et garder le nom identique tout au long du paramétrage.

liens vers la serie complet :
http://pint2stone.blogspot.com/2010/12/mon-premier-module-joomla-1.html
http://pint2stone.blogspot.com/2010/12/mon-premier-module-joomla-2.html
http://pint2stone.blogspot.com/2010/12/mon-premier-module-joomla-3.html
http://pint2stone.blogspot.com/2010/12/mon-premier-module-joomla-4.html