Outils d'utilisateurs

Outils du Site


documentation_developpeurs:conventions_de_nommage

Différences

Cette page vous donne les différences entre la révision choisie et la version actuelle de la page.

Lien vers cette vue

documentation_developpeurs:conventions_de_nommage [2009/09/22 22:17] (Version actuelle)
Ligne 1: Ligne 1:
 +====== 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 table|t_product|
 +|Attributs de la table|pro_reference|
 +|Clefs étrangères|pro_pro2_reference|
 +===== Fichiers PHP =====
 +==== Fichier PHP standard (entrée) ====
 +|Nom du fichier|name_of_page.php|
 +==== Fichier PHP inclus n’étant pas une classe ====
 +|Nom du fichier|includename.inc.php|
 +==== Fichier PHP représentant une classe ====
 +|Nom du fichier|classname.class.php|
 +==== Classes (.class.php) ====
 +=== Classe liée à une table en base de donnée ===
 +|Nom du fichier|tablename.class.php|
 +
 +|classe protected|xnameofclass.class.php|
 +|Nom de la classe protected|XnameOfClass|
 +
 +=== Classes du FrontOffice ===
 +
 +|Nom du fichier|tablename_fo.class.php|
 +
 +
 +===== Patrons (smarty tpl) =====
 +==== Représentant une page Internet ====
 +|Nom du fichier|filename.tpl|
 +==== Inclus dans un autre patron ====
 +|Nom du fichier|filename.inc.tpl|
 +
 +===== Variables =====
 +|Variable texte|the_variable_name|
 +|Variable Boolean|is_the_variable_name|
 +|Variable Array|array_the_variable_name|
 +|Variable texte affichant un input|input_the_variable_name|
 +|Variable de debug|debug_the_variable_name|
 +===== Contenu HTML =====
 +==== Formulaires ====
 +|Nom d’un formulaire|fn_form_name|
 +|Nom d’un champ input|f_input_name|
 +|Nom d’un id de champ|fid_input_id_name|
 +===== Contenu PHP =====
 +==== Méthodes ====
 +|Valeur de retour|TRUE (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 publiques|maMethodePublique|
 +|Méthodes privée|xMaMethodePrivee|
 +|Obtenir un objet|xGetObjectTProductMaster (cette fonction
 + ne renvoi pas TRUE ou FALSE 
 +mais l’objet)|
 +
 +==== Variables ====
 +
 +|Constantes|CONST_NOM_CONSTANTE|
 +|Globales|g_the_var|
 +|Membre d’un classe|m_the_var|
 +|Paramètre de fonction|p_the_var|
 +|Passée par référence|r_the_var|
 +
 +|Paramètre et référence|pr_the_var|
 +
 +|Une requête SQL|req_the_var|
 +
 +|Un objet|object_theobjectwithoutunderscore|
 +|Un objet de type membre|m_object_theobjectwithoutunderscore|
 +|Un objet de type global|g_object_theobjectwithoutunderscore|
 +
 +=== Méthodes courantes ===
 +
 +|Suppression|delete ou deleteByPmaid|
 +|Ajout|insert|
 +|Modification|update ou updateByPmaId|
 +|Obtenir une ligne|get|
 +|Obtenir + lignes|getList|
 +
 +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)