Langages et normes: Difference between revisions

m
no edit summary
mNo edit summary
Line 1: Line 1:
Voici les quelques règles sur le langage, la syntaxe et normes de développement en vigueur pour le projet Dolibarr:
Voici les quelques règles sur le langage, la syntaxe et normes de développement en vigueur pour le projet Dolibarr:


== Syntaxe PHP et objet ==
 
== Versions ==
 
* Dolibarr doit fonctionner sur:
# Tous OS (Windows, Linux, MACOS...)
# PHP 4.1 ou + (Doit fonctionner sans aucun module PHP complémentaire hors les modules d'accès base de donnée).
# 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
* Dolibarr est écrit en PHP et supporte toutes versions PHP supérieures à la 4.1. Les fichiers doivent tous comporter l'extension .php
Line 11: Line 20:
* Les smart tags PHP ne sont pas utilisés. Les sections de code doivent commencer par '''<?php'''
* 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'''
* 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.
<pre>
print 'Mon texte affiche ma '.$variable.' !';
</pre>


* 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
* 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
Line 32: Line 46:
</pre>
</pre>


== Syntaxe SQL ==
* 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:
* 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:


Line 41: Line 62:
  INSERT INTO table_1 (field_txt, field_num) VALUES ('txt','1234')
  INSERT INTO table_1 (field_txt, field_num) VALUES ('txt','1234')


== Fonctions ==


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.
== Autre ==


* 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.
== Normes HTML ==


* Tous les attributs dans les balises HTML doivent être *en minuscule* et quottés avec des *doubles quote* (Norme xhtml)
* Tous les attributs dans les balises HTML doivent être *en minuscule* et quottés avec des *doubles quote* (Norme xhtml)
Line 66: Line 82:
</pre>
</pre>


* Les popups windows ne doivent pas être utilisées.
* 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.
* 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 ==
== Squelettes de code ==