GLPI-PROJECT

Indentation

One tabulation

{{{
// base level
// level 1
// level 2
// level 1
// base level
?>
}}}

Control structures

{{{
if ($test1){
for ($i=0;$i<$end;$i++){
echo "test ".( $i<10 ? "0$i" : $i )."<br>";
}
}

switch ($test2){
case 1 :
echo "Case 1";
break;
case 2 :
echo "Case 2";
break;
default :
echo "Default Case";
break;
}

?>
}}}

Including files

require_once ?

include_once ?

PHP tags

Short tag not allowed. Use complet tags.

{{{

// code

?>
}}}

Functions

Function names should be written in camelBack, for example:

{{{
function userName() {
}
?>
}}}

Class

Class names should be written in CamelCase, for example:

{{{
class ExampleAuthentification {
}
?>
}}}

Variables

Variable names should be as descriptive and short as possible.
Normal variables should be written in lower case. In case of multiple words use the _ separator.
Global variables should be written in UPPER case. In case of multiple words use the _ separator.

Example:

{{{
$user = 'glpi';
$users = array('glpi', 'glpi2', 'glpi3');
$users_groups = array('glpi', 'glpi2', 'glpi3');

$CFG_GLPI=array();

?>

}}}

Variable types

Variable types for use in DocBlocks for Doxygen:

	Type		Description
	mixed		A variable with undefined (or multiple) type.
	integer		Integer type variable (whole number).
	float		Float type (point number).
	boolean		Logical type (true or false).
	string		String type (any value in "" or ' ').
	array		Array type.
	object		Object type.
	ressource		Resource type (returned by for example mysql_connect()).

Files

Lower case

Constants

Capital letter :

{{{
COMPUTER_TYPE
}}}