1.13 Les normes de programmation Laravel

Selon la documentation de Laravel :

Laravel follows the PSR-2 coding standard and the PSR-4 autoloading standard.

Ces normes ont été écrites par un consortium composé de grands acteurs du monde PHP, le PHP Framework Interoperability Group ou, pour faire court, le FIG.

Elles précisent comment le code doit être écrit, comment les classes, objets, constantes doivent être nommés, etc.

Voici quelques points importants à retenir :

• Les fichiers contenant le code PHP doivent utiliser l'encodage UTF-8 sans BOM.
• Il faut toujours utiliser 4 espaces pour indenter le code, et non une tabulation.
• Les noms de classes doivent utiliser la casse Pascal (ex : MaClasse).
• Les constantes doivent être écrites entièrement en majuscules et utiliser des tirets bas (_) pour séparer les mots (ex : MA_CONSTANTE).
• Le nom des méthodes doivent utiliser la casse chameau (ex : maMethode).
• Lors de la déclaration d'une classe, l'accolade ouvrante doit être placée sur la ligne suivant la déclaration de la classe.

  Ex :

  PHP

  class PagesController extends Controller

  {

      ...

  }

• Lors de la déclaration de méthodes, l'accolade ouvrante doit être placée sur la ligne suivant la déclaration de la méthode.

  Ex :

  PHP

  public function index()

  {

      ...

  }

• Pour les structures de contrôle, l'accolade ouvrante doit être placée sur la MÊME ligne que la structure de contrôle.

  Ex :

  PHP

  if (Produit::count() > 0) {

      ...

  }

Source : http://xkcd.com/927/

Pour plus d'information

« Coding Style Guide ». GitHub. https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md

« PSR-2: Guide pour le style d'écriture de code ». PHP-FIG. http://www.php-fig.org/psr/psr-2/fr/

« Laravel: Best Practices ». Laravel: Best Practices. http://www.laravelbestpractices.com/

« How To Do Best Coding Practices In Laravel ». Dunebook. https://www.dunebook.com/how-to-do-best-coding-practices-in-laravel-5/