Langages et normes

From Dolibarr ERP CRM Wiki
Revision as of 16:19, 15 September 2007 by Eldy (talk | contribs)
Jump to navigation Jump to search

Voici les quelques règles sur le langage, la syntaxe et normes de développement en vigueur pour le projet Dolibarr:


Versions

  • Dolibarr doit fonctionner sur:
  1. Tous OS (Windows, Linux, MACOS...)
  2. PHP 4.1 ou + (Doit fonctionner sans aucun module PHP complémentaire hors les modules d'accès base de donnée).
  3. Mysql 3.1 ou +


Normes PHP

  • Dolibarr est écrit en PHP et supporte toutes versions PHP supérieures à la 4.1. Les fichiers doivent tous comporter l'extension .php
  • L'appel aux variables superglobales PHP doit passer par les opérateurs dédiés $_GET, $_POST, $_COOKIES, $_SERVER, $_ENV.

Les autres opérateurs ($HTTP_SERVER_GET, ...) ayant été passé en deprecated au sein de PHP, ne doivent plus être utilisées. Ainsi le code doit fonctionner y compris quand l'option register_long_arrays est à off. De plus, le code doit fonctionner quand l'option PHP register_globals est à off (recommandé par PHP) aussi bien que quand l'option register_globals à on (par défaut sur de nombreuses installations).

  • Les smart tags PHP ne sont pas utilisés. Les sections de code doivent commencer par <?php
  • Pas d'utilisation de la variable PHP_SELF. Utiliser a la place $_SERVER["PHP_SELF"]
  • Les chaines doivent etre encadrés de simple quote et les variables sorties de la chaine.
print 'Mon texte affiche ma '.$variable.' !';
  • Les commentaires doivent suivre la syntaxe C, ie un double antislash pour un commentaire d'une ligne et utilisation slash-étoile pour ouvrir un bloc de plusieurs ligne

/* Bloc de commentaire
 *
 * Fin du bloc
 */

$monobjet = new MonObjet($db);
$result=$monobjet->fetch($idobject);

for ($i = 1 , $i < 2 ; $i++)
{
  // commentaire sur une ligne
  print $i;
}

  • Les fichiers doivent etre sauvés en format Unix (LF) et non Windows (CR/LF). Le format Unix étant compatible sur les OS Unix like, Windows, Mac, alors que le format fichier texte Windows pose problème sous certains PHP sous Unix.

Les fonctions doivent retourner 0 en cas de succès, et un nombre <0 en cas d'erreur. A ce jour, très peu de fonctions respectent ce standard mais c'est celui vers lequel il faut tendre.


Normes SQL

  • Les SELECT * sont interdits ! Chaque SELECT doit spécifier la liste complète des champs à récupérer. Cela permet d'éviter les confusions. Exemple:
SELECT field_a, field_b, field_c FROM table_1 WHERE field_d = '$id'
  • Dans les requètes sql, on quote les numériques ! Exemple:
INSERT INTO table_1 (field_txt, field_num) VALUES ('txt','1234')


Normes HTML

  • Tous les attributs dans les balises HTML doivent être *en minuscule* et quottés avec des *doubles quote* (Norme xhtml)
  • Les liens href doivent etre absolu et se baser pour les pages sur la constante DOL_URL_ROOT qui pointe sur htdocs et pour les images se base sur l'appel de la fonction img_picto.

Par exemple:

print '<a href="'.DOL_URL_ROOT.'/monrep/mapage.php">'.img_picto('Texte alt','nompictopng','').'</a>';
  • Le javascript et l'appel aux scripts java dans les pages php est à proscrire. Si toutefois du code javascript est inclus, il doit être conditionné par le test sur "$conf->use_javascript"
if ($conf->use_javascript)
{
...  // Le code php qui génère du javascript est ici
}
  • Les popups windows ne doivent pas être utilisées, sauf pour des tooltips (et restent condtionner par le point ci-dessus).
  • Les scripts externes sont écrits en Perl s'ils ne peuvent l'être en php, l'utilisation d'un autre langage n'est pas interdit mais doit être discuté au préalable dans la mailing list des développeurs. Le langage devra être maitrisé par au moins 2 développeurs pour en assurer la maintenance.


Squelettes de code

Afin d'uniformiser le code et d'accélérer le développement de nouveaux composants dans Dolibarr, se trouve dans le répertoire dev/skeletons, 3 squelettes de code tout préparé.

  • 1 qui sert d'exemple de code pour faire une nouvelle classe: skeleton_class.class.php
  • 1 qui sert d'exemple de code pour faire une nouvelle page: skeleton_page.php
  • 1 qui sert d'exemple de code pour faire un script à exécuter en ligne de commande: skeleton_script.php