Howto développer un module Zwook

Howto développer un module Zwook

Aller dans le dossier zwo_modules.



Dupliquer exemplemodule



Le renommer avec le nom de votre choix : pour l'exemple ce sera le module "hello_world"



Un module se compose au minimum des fichiers suivants :

- new_html : interface html pour la création du module
- new_ok : script enregistrant les données du module lors de la création du module
- config_html : interface html pour la configuration du module
- config_ok : script enregistrant les données du module lors de la configuration du module
- view_html : script d'affichage du module

Passons maintenant aux choses sérieuses ; on attaque le code. Paramétrons d'abord les interfaces de gestion du module (new_html, new_ok, config_html, config_ok). Commencons par new_html



Les lignes a personnaliser sont surlignées en rouge. On met un champs texte pour demander quel texte afficher. Noter l'attribut name="texte_aff" qui permet d'identifier le champs.



On passe ensuite a new_ok, qui est la page dans laquelle va etre traité le formulaire contenu dans new_html



On passe les noms des champs a traiter en paramètre du script : ici "texte_aff".
On ajoute ensuite une propriété a l'instance du module : cette propriété est nommée texte_aff et est de type string



Bien. Maintenant faisons les memes types de réglages pour les scripts config_html et config_ok, qui sont lancés lorsque l'utilisateur reconfigure un module dans l'interface.



On récupère la valeur de la propriété text_aff (propriété de l'instance du module) et on l'affiche dans un champs html



Passons a config_ok



Bien veiller a passer le(s) paramètre(s) au script : ici "texte_aff". Puis on enregistre les données dans la propriété "text_aff" existante (celle qui a été crée dans new_ok).



Terminé pour les interfaces, maintenant l'affichage du module dans la page avec view_html.
D'abord on récupère le texte (dans la propriété text_aff), puis on l'affiche.



Passons au réglages des propriétés du module lui-meme, maintenant que le code est fait.
Les propriétés essentielles sont en rouge :
- titre : titre du module (celui qui sera affiché dans les interfaces)
- note : mettre une note positive sinon le module n'apparaitra pas dans la liste des modules dans administration. Cette note sert a classer les modules dans la liste de la page administration.
- moderateur : email du modérateur du module (le développeur en du module en géneral)
Les autres propriétés a changer sont en vert:
- version : version du module
- dev : pourcentage de développement du module
- description : description du module : celle qui apparait dans la liste des modules dans administration



Il ne nous reste plus qu'a activer le module en allant dans Administration -> Modules



Le module est presque ok: reste a lui créer une icone personalisée en changeant l'image icone.gif ..