Conventions officielles de nommage

(D'aprês le XoopsWiki)

Il est important de se conformer à  ces rêgles d'appellation, en particulier celles où le préfixage avec le nom du module est requis :

• pour obtenir un fonctionnement correct du module, notamment à  l'installation,
• pour prévenir tout conflit qui pourrait survenir avec d'autres modules qui disposeraient p.ex de fonctions portant le même nom
• pour une utilisation adéquate de fonctions du core telles que xoops_getmodulehandler

Nom du module

• A choisir avec attention car il conditionne l'appellation de nombreux autres éléments : tables, répertoire, etc.
• Combinaison de majuscules et minuscules sans caractêres spéciaux.
• Identique ou similaire au répertoire du module
• Ne pas utiliser le préfixe xoops qui est réservé aux modules officiels, ni un préfixe utilisé par un groupe de développement (WF, smart, etc)
• Ex : MyModule

Répertoire du module

• minuscules uniquement sans caratêres spéciaux.
• Ex : mymodule

Tables du module

• préfixer avec le nom du répertoire du module, et séparer les mots par underscore '_'
• ne pas mettre le préfixe xoops, qui sera automatiquement ajouté à  l'installation du module.
• minuscules uniquement .
• Ex : mymodule_mytable

Fonctions générales

• préfixer avec le nom du répertoire du module, et séparer les mots par underscore '_'
• minuscules uniquement .
• Ex : mymodule_myfunction

Fonctions des blocs

• préfixer avec b_ suivi du nom du répertoire du module, et séparer les mots par underscore '_'
• minuscules uniquement .
• Ex : b_mymodule_myfunction

Variables

• ne jamais utiliser le préfixe xoops
• minuscules uniquement avec séparation des mots par underscore '_'
• Ex : $title, $new_post

Classes

• ne jamais utiliser le préfixe xoops
• Préfixer avec le nom du répertoire du module avec le premier caractêre en majuscule
• séparation des mots par majuscule
• Ex : MymoduleMyclass

Méthodes

• ne jamais utiliser le préfixe xoops
• séparation des mots par majuscule
• Ex : myMethod

<a href="http://creativecommons.org/licenses/by-nc-sa/2.0/fr/" title="Licence, certains droits réservés"><img src="http://www.frxoops.org/images/cdr_bouton.gif" alt="Licence, certains droits réservés" /></a>