Sprachen und Programmierregeln: Difference between revisions

These are some rules on language, syntax and norm we use in the Dolibarr project:

=Versions=

*Dolibarr must work on:

#All OS (Windows, Linux, MACOS...)

#PHP {{PHPMinVersion}} (Must work with no need of complementary PHP module, except module to PHP module to access database).

=Copyright Norms=

*All PHP files must start with a header that looks like

When you edit an existing file of project, you must add a Copyright line under others.

=PHP Norms=

*Dolibarr is written with PHP and supports all versions of PHP higher than {{PHPMinVersion}}. All files must end with extension .php

*Usage of PHP superglobals variables must use the dedicated operators $_COOKIES, $_SERVER, $_ENV but use the Dolibarr function GETPOST() to get the contents of $_GET or $_POST..

*Other operators ($HTTP_SERVER_GET, ...) are now deprecated in PHP, so they must not be used. Code must work if option '''register_long_arrays''' is set to off. Moreover, the code must work when PHP option '''register_globals''' is off (recommended by PHP). It must also work  if the option '''register_globals''' is on (by default on a lot of installations).

*Do not use '''<s>PHP_SELF</s>'''. Use instead '''$_SERVER["PHP_SELF"]'''. Also, Dolibarr framework sanitizes content of $_SERVER["PHP_SELF"] variable (into main.inc.php file, before any business code).

*When several variables must be initialized with the same value, you must use individual declarations (separated by ;)

which is slower.

*Strings must be delimited by a single or double quote and a variable within the string must be outside of the quote.

====Comments====

*Comments must use the C syntax, ie a double slash for a comment on one line and a slash-star to open a bloc for several lines