La cohérence d'un projet logiciel passe par une uniformisation du code écrit. C'est pourquoi tout projet qui se respecte a son guide de style. Cet article présente le guide de style utilisé pour l'écriture du code PHP par PHPBoost.
Indentations et espaces
Les blocs
Qu'il soit engendré par une condition, une boucle ou autre, un bloc (encadré par des accolades) s'indente avec 4 espaces comme dans l'exemple suivant :
Les conditions / boucles
Les conditions et les boucles s'écrivent avec un espace après le mot clé (if / elseif / else / while / for / foreach) et sans espace ailleurs :
Une imbrication donne le code suivant, en tenant compte de la règle sur les blocs :
De même, les boucles for et while donnent ceci :
Règles de nommage
Les règles de nommage que nous utilisons sont assez similaires à celles de l'API PHP.
Variables
Les variables sont écrites avec des blancs soulignés pour remplacer les espaces.
Une variable locale commence par une minuscule, tandis qu'une variable globale à l'application commence par une majuscule ou est même éventuellement écrite entièrement en majuscule.
Exemple :
Les fonctions / méthodes
Les noms de fonction et méthodes s'écrivent de la même manière que les noms de variables, avec des blancs soulignés pour remplacer les espace. Tous les noms de fonction sont en minuscules.
Publiques
Les méthodes publiques s'écrivent selon l'exemple suivant :
Privées
Les noms de méthode privées commencent par un blanc souligné de façon à marquer le fait qu'elles ont une portée réduite. L'exemple suivant le montre :
Les classes
Les classes font exception aux règles précédentes. Elles commencent par une majuscule et s'écrivent en
CamelCase.
Exemple :