Outils d'utilisateurs

Outils du Site


documentation_developpeurs:conventions_de_nommage

Conventions de nommage

Valable pour tous

Langue utilisée : ANGLAIS Nom des tables : au singulier

Répertoires et fichiers

Tout en minuscule, singulier pas de caractères accentués et _ pour séparer les mots. Si le répertoire contient une classe, il porte le nom de la classe en minuscule.

Base de données

Exemple pour la table « products »

Nom de la tablet_product
Attributs de la tablepro_reference
Clefs étrangèrespro_pro2_reference

Fichiers PHP

Fichier PHP standard (entrée)

Nom du fichiername_of_page.php

Fichier PHP inclus n’étant pas une classe

Nom du fichierincludename.inc.php

Fichier PHP représentant une classe

Nom du fichierclassname.class.php

Classes (.class.php)

Classe liée à une table en base de donnée

Nom du fichiertablename.class.php
classe protectedxnameofclass.class.php
Nom de la classe protectedXnameOfClass

Classes du FrontOffice

Nom du fichiertablename_fo.class.php

Patrons (smarty tpl)

Représentant une page Internet

Nom du fichierfilename.tpl

Inclus dans un autre patron

Nom du fichierfilename.inc.tpl

Variables

Variable textethe_variable_name
Variable Booleanis_the_variable_name
Variable Arrayarray_the_variable_name
Variable texte affichant un inputinput_the_variable_name
Variable de debugdebug_the_variable_name

Contenu HTML

Formulaires

Nom d’un formulairefn_form_name
Nom d’un champ inputf_input_name
Nom d’un id de champfid_input_id_name

Contenu PHP

Méthodes

Valeur de retourTRUE (il y a une erreur) FALSE (pas d’erreur)

Cette note précédente ne s’applique qu’aux fonctions dont on peut déterminer une erreur en retour. Les fonctions ne pouvant pas renvoyer d’erreur renvoient directement le résultat.

Méthodes publiquesmaMethodePublique
Méthodes privéexMaMethodePrivee
Obtenir un objet

ne renvoi pas TRUE ou FALSE mais l’objet)|

Variables

ConstantesCONST_NOM_CONSTANTE
Globalesg_the_var
Membre d’un classem_the_var
Paramètre de fonctionp_the_var
Passée par référencer_the_var
Paramètre et référencepr_the_var
Une requête SQLreq_the_var
Un objetobject_theobjectwithoutunderscore
Un objet de type membrem_object_theobjectwithoutunderscore
Un objet de type globalg_object_theobjectwithoutunderscore

Méthodes courantes

Suppressiondelete ou deleteByPmaid
Ajoutinsert
Modificationupdate ou updateByPmaId
Obtenir une ligneget
Obtenir + lignesgetList

Toutes les méthodes ne peuvent renvoyer que TRUE ou FALSE voir ci-dessous, par conséquent, les valeurs à retourner sont passées par référence.

/home/pliciweb/www_wiki/data/pages/documentation_developpeurs/conventions_de_nommage.txt · Dernière modification: 2009/09/22 22:17 (modification externe)