Skip to content
This repository has been archived by the owner on Nov 28, 2021. It is now read-only.

Convention et règles

apuyou edited this page Nov 18, 2012 · 1 revision

Convention et règles

Nous suivrons la plupart des conventions de codages de symfony : http://trac.symfony-project.org/wiki/HowToContributeToSymfony

Indentation

L'indentation doit être réalisée avec des espaces et non la tabulation classique. La plupart des IDE permettent de transformer automatiquement la touche tab en espaces. On fixe la longueur d'une tabulation à 2 espaces.

CSS, Javascripts et images

L'ensemble des URLs doivent être absolues du type : /images/background.jpg, /js/main.js, /css/main.css. Les fichiers sont pris directement dans le dossier /web

Pour le chargement automatique des fichiers css et js, il est inutile de préciser le dossier. On peut les appeler directement depuis les view.yml ou dans les vues avec les use_stylesheet et use_javascript avec leur nom et extension : main.js, main.css.

Methode des tables

Chaque table est un singleton, aucune de leur méthode ne doit être statique en dehors de la fonction getInstance(). Pour faire appel à une requête que vous aurez codé dans une méthode, il faut procéder de la sorte :

$retour = ObjetTable::getInstance()->maMethode();

Récupération des clés primaires

Dans la mesure où les champs id sont générés automatiquement par doctrine, nous n'utilisons pas les fonction getId(), mais uniquement les fontion getPrimaryKey().

PHP et les vues

Il faut utiliser le moins possible de PHP dans les vues.

Les short_tag ne sont pas autorisés.

Seules les structures de contrôles sont autorisées.

<?php if($condition): ?>
HTML
<?php endif ?>

<?php foreach($collection as $objet): ?>
HTML
<?php endforeach ?>

Il n'est pas nécessaire de mettre des ; avant les balises fermantes.

Les conditions ternaires sont autorisés pour des assignations.