Langages et normes: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (→Autres) |
||
| Line 35: | Line 35: | ||
== Autres == | == Autres == | ||
* Les fichiers doivent etre sauvés en format Unix (LF) et non Windows (CR/LF). Le format Unix étant compatible Unix, Windows, Mac alors que le format Windows pose problème sus certains PHP sous Unix. | * 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 sus certains PHP sous Unix. | ||
* Les popups windows ne doivent pas être utilisées. | * Les popups windows ne doivent pas être utilisées. | ||
| Line 41: | Line 41: | ||
* 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) | ||
* Le javascript et l'appel aux scripts java dans les pages php est à proscrire. | * 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" | ||
* Les scripts externes sont écrits en Perl | * 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. | ||
Revision as of 02:36, 8 October 2005
Voici les quelques règles sur le langage, la syntaxe et normes de développement en vigueur pour le projet Dolibarr:
Syntaxe 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
- 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
*/
for ($i = 1 , $i < 2 ; $i++)
{
// commentaire sur une ligne
print $i;
}
Syntaxe SQL
- Les SELECT * sont interdits !
- Dans les requètes sql on quote les numériques !
Autres
- 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 sus certains PHP sous Unix.
- Les popups windows ne doivent pas être utilisées.
- Tous les attributs dans les balises HTML doivent être *en minuscule* et quottés avec des *doubles quote* (Norme xhtml)
- 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"
- 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.