Technologies Internet et Education, © TECFA
  4. Ecrire un module

---

4.1 Les conventions d'écriture de code

• Utiliser des préfixes pour les variables: OBJ_ (objets), CNT_ (contenu d'un module) SES_ (variables de sessions), CLS_ (classes). Par exemple: OBJ_friends = new CLS_friends
• Garder un bout du nom du module dans chacun des éléments qui s'y rapportent.
• Préfixer les tables de la base de données par mod_<le nom du module>
• Utiliser <?php (et non pas <? ou <?PHP )
• Séparer la logique de la présentation
• Utiliser le caractère '_' pour séparer les noms
• Eviter d'inclure des fichiers inutiles
• ... Voir la documentation de phpWebSite

4.2 La documentation

Bien documenter son code est important pour la lisibilité de son programme pour soi-même et pour les autres. L'utilisation de l'outil PHPDoc

• http://www.phpdoc.de

Cet outils permet de générer (si le code à été commenté correctement) de la documentation au format HTML.

Voir la documentation de phpWebSite et de PHPDoc

4.3 Les fonctions existantes

Plusieurs fonctions sont utilisables dans phpWebSite. Elles peuvent gérer:

• Les permissions: $OBJ_user->allow_access()
• Le support des langues : $translate->it("texte à traduire")
• Le layout : thememainbox($title, $content)
• Les formulaires HTML, ...