jeudi 30 décembre 2010

Mon premier Module Joomla #3

Les fichiers xml et ini

Vous pouvez télécharger tout ces fichiers à :
http://sites.google.com/site/pint2stone/mod_server_health.zip

Ici je vais presenterr le fichier mod_server_health.xml avec les commentaires en français :

<?xml version="1.0" encoding="utf-8"?>
<install type="module" version="1.5.0">
    <!-- Le nom du module -->
        <name>Server Health</name> 
 
    <!-- Nom de l'auteur -->
        <author>Stone</author> 
 
    <!-- date de notre version actuel -->
        <creationDate>2010-12-23</creationDate> 
 
    <!-- Copyright -->
        <copyright>Aucun copyright, que ceci sert d'exemple</copyright> 
 
    <!-- Information sur la license -->
        <license>utilise ceic et ameillore le, au pire GPL 2.0 !</license> 
 
    <!-- Adresse mail de l'auteur -->
        <authorEmail>Aucun@rien.fr</authorEmail> 
 
    <!-- site web de l'auteur -->
        <authorUrl>pint2stone.blogspot.com</authorUrl> 
 
    <!-- Numero de version actuel -->
        <version>1.1.0</version> 
 
    <!-- decrit le fonctionnement du module -->
        <description>Verifie si un serveur repond sur un certain port, exemple : www.google.com sur le port 80</description>
 
    <!-- Liste de tout les fichiers qui doivent etre installés -->
        <files>
        <!-- l'attribue "module" signifie que ceci est le fichier de controle principal -->
                <filename module="mod_server_health">mod_server_health.php</filename>
                <filename>index.html</filename>
    <filename>helper.php</filename>
    <filename>tmpl/default.php</filename>
    <filename>tmpl/index.html</filename>
        </files>
  <languages>
   <!-- Tout les fichiers de langue a inclure -->
   <language tag="en-GB">en-GB.mod_server_health.ini</language>
   <language tag="fr-FR">fr-FR.mod_server_health.ini</language>
  </languages>

    <!-- Les options configurables du module -->
        <params>
 
        <!-- Les paramettres qui permettenet à l'admin du site de modifier le serveur et le port a tester -->
  <!-- le defaut est ceux qui est present par defaut dans les cases, ca sert d'aide -->
  <!-- label et description sont les titres et les descriptions, ces valeurs sont recuperer depuis les fichiers langues -->
        <param name="domainbase" type="text" default="www.google.com" label="DOMAIN TEST" description="DESC DOMAIN TEST" />
  <param name="domainport" type="text" default="80" label="DOMAIN PORT" description="DESC DOMAIN PORT" />
    </params>

</install>

Ceux qui nous donne ceci dans Joomla :


Tout les autres paramètres du fichier sont utilisé lors de l'install du module dans Joomla. les plus importants sont les fichiers a installer (ne pas se tromper de nom ni les oublier). Tout les autres peuvent être gérer dans le code mais votre module sera moins flexible sans les paramètres proposé à l'administrateur du site et moins atreyant si on est obligé de démonter tout votre code pour le traduire.

Et voici le contenu du fichier fr-FR.mod_server_health.ini

DOMAIN TEST=Domaine a tester
DESC DOMAIN TEST=Le domaine que vous souhaitez verifier
DOMAIN PORT=Port du domaine
DESC DOMAIN PORT=Le port sur laquel vous souhaitez tester
IS_ALIVE=est ACTIVE
IS_DOWN=ne repond pas


Les 4 premiers lignes corespondent aux traductions de nos paramettres dans le fichier xml. Les deux derniers sont pour l’affichage sur le site.

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