Framework

Guide de style

Table des matières

Indentations et espaces
1. Les blocs
2. Les conditions / boucles
Règles de nommage

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 :

Code PHP :

{
    echo 'Bonjour';
}

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 :

Code PHP :

if ($var == 2)
{
    echo '$var vaut 2';
}
elseif ($var == 3)
{
    echo '$var vaut 3';
} 
else
{
    echo '$var vaut 4';
}

Une imbrication donne le code suivant, en tenant compte de la règle sur les blocs :

Code PHP :

if ($var > 1)
{
    if ($var == 2)
    {
        echo '$var vaut 2';
$var = 3;
    }
    else
    {
        echo '$var différent de 2';
        $var = 4;
    }
}

De même, les boucles for et while donnent ceci :

Code PHP :

for ($i = 0; $i < 5; $i++)
{
    echo $i;
}

Code PHP :

$i = 0;
while ($i < 5)
{
    echo $i;
    $i++;
}

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 :

Code PHP :

$page_name = 'nom de la page';
//La variable $page_name est locale tandis que $CONFIG est importée de l'environnement de PHPBoost
echo 'Bienvenue sur la page ' . $page_name . ' du site ' . $CONFIG['site_name'];

Code PHP :

//Appel d'un objet du noyau PHPBoost
$Cache->load_file('config');

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 :

Code PHP :

function parse_text($string)
{
    //Code de la fonction
}

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 :

Code PHP :

class MaClasse
{
    function _ma_methode_privee()
    {
        //code
    }
}

Les classes

Les classes font exception aux règles précédentes. Elles commencent par une majuscule et s'écrivent en CamelCase.
Exemple :

Code PHP :

class MaClasse
{
    //Code de la classe
}