Table of contents
Table of Contents | ||
---|---|---|
|
...
PrestaShop development standard
...
PHP
Variable names
- Corresponding to data from databases:
$my_var
. - Corresponding to algorithm:
$my_var
. - The visibility of a member variable does not affect its name:
private $my_var
.
...
Code Block | ||
---|---|---|
| ||
$my_var = 17;
$a = $b;
|
Operators
"+", "-", "*", "/", "=" and any combination of them (e.g. "/=") need a space between their left and right members.
Code Block borderStyle solid $a + 17; $result = $b / 2; $i += 34;
"." does not have a space between its left and right members.
Code Block borderStyle solid echo $a.$b; $c = $d.$this->foo();
Note title Recommendation For performance reasons, please do not overuse concatenation.
"
.=
" needs a space between its left and right members.Code Block borderStyle solid $a .= 'Debug';
Statements
if, elseif, while, for: need a space between the
if
keyword and the bracket()
.Code Block borderStyle solid if (<condition>) ... while (<condition>)
When a combination of if and else is used and both can return a value, the else has to be avoided.
Code Block borderStyle solid if (<condition>) return false; return true;
Note title Recommendation We recommend one return per method / function
When a method/function returns a boolean and the current method/function's returned value depends on it, the if statement has to be avoided
Code Block borderStyle solid public aFirstMethod() { return $this->aSecondMethod(); }
Tests must be grouped by "entity"
Code Block borderStyle solid if ($price AND !empty($price)) ... if (!Validate::$myObject OR $myObject->id === NULL) ...
...
- The visibility must be defined every time, even when it is a public method.
The order of the method properties should be:
visibility static function functionName()
.Code Block borderStyle solid private static function foo()
Method / Function names
Method and function names always use CamelCase: begin with a lowercase character and each following words must begin with an uppercase character.
Code Block borderStyle solid public function myExampleMethodWithALotOfWordsInItsName()
Braces introducing method code have to be preceded by a carriage return.
Code Block borderStyle solid public function myMethod($arg1, $arg2) { ... }
Method and function names must be explicit, so function names such as
b()
oref()
are completely forbidden.Info title Exceptions The only exceptions are the translation function (called
l()
) and debug the functions (namedp()
andd()
).
...
Code Block | ||
---|---|---|
| ||
protected function myProtectedMethod($arg1, $arg2, $arg3 = null)
|
Objects / Classes
Object name must be singular.
Code Block borderStyle solid class Customer
Class name must follow the CamelCase practice, except that the first letter is uppercase.
Code Block borderStyle solid class MyBeautifulClass
Defines
- Define names must be written in uppercase
Define names have to be prefixed by "PS_" inside the core and module
Code Block borderStyle solid define('PS_DEBUG', 1); define('PS_MODULE_NAME_DEBUG', 1);
- Define names does not allow none alphabetical characters. Except "_".
...
Code Block | ||
---|---|---|
| ||
echo 'Debug';
$myObj->name = 'Hello '.$name;
|
...
- Inside functions and methods, only the "//" comment tag is allowed.
After the "//" comment marker, a space is required:
// Comment
.Code Block borderStyle solid // My great comment
The "//" comment marker is tolerated at the end of a code line.
Code Block borderStyle solid $a = 17 + 23; // A comment inside my example function
Outside of functions and methods, only the "/" and "/" comment markers are allowed.
Code Block borderStyle solid /* This method is required for compatibility issues */ public function foo() { // Some code explanation right here ... }
PHP Doc comment block is required before the declaration of the method.
Code Block borderStyle solid /** * Return field value if possible (both classical and multilingual fields) * * Case 1: Return value if present in $_POST / $_GET * Case 2: Return object value * * @param object $obj Object * @param string $key Field name * @param integer $id_lang Language id (optional) * @return string */ protected function getFieldValue($obj, $key, $id_lang = NULL)
Info title For more informations For more informations about the PHP Doc syntax: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html
Return values
The return statement does not need brackets, except when it deals with a composed expression.
Code Block borderStyle solid return $result; return ($a + $b); return (a() - b()); return true;
The return statement can be used to break out of a function.
Code Block borderStyle solid return;
Call
Function call preceded by a "@" is forbidden but beware with function / method call with login / password or path arguments.
Code Block | ||
---|---|---|
| ||
myfunction()
// In the following example, we put a @ for security reasons
@mysql_connect(...);
|
Tags
There must be an empty line after the PHP opening tag.
Code Block borderStyle solid <?php require_once('my_file.inc.php');
- The PHP ending tag is forbidden
...
- The tabulation character ("
t") is the only indentation character allowed. Each indentation level must be represented by a single tabulation character.
Code Block borderStyle solid function foo($a) { if ($a == null) return false; ... }
Array
The
array
keyword must not be followed by a space.Code Block borderStyle solid array(17, 23, 42);
When too much data is inside an array, the indentation has to follow the following.
Code Block borderStyle solid $a = array( 36 => $b, $c => 'foo', $d => array(17, 23, 42), $e => array( 0 => 'zero', 1 => $one ) );
...
Code Block | ||
---|---|---|
| ||
if (!$result)
return false;
for ($i = 0; $i < 17; $i++)
if ($myArray[$i] == $value)
$result[] = $myArray[$i];
else
$failed++;
|
Security
All user's data (data entered by users) has to be cast.
Code Block borderStyle solid $data = Tools::getValue('name'); $myObject->street_number = (int)Tools::getValue('street_number');
All method/function's parameters must be typed (when Array or Object) when received.
Code Block borderStyle solid public myMethod(Array $var1, $var2, Object $var3)
For all other parameters, they have to be cast each time they are used, except when they are sent to other methods/functions.
Code Block borderStyle solid protected myProtectedMethod($id, $text, $price) { $this->id = (int)$id; $this->price = (float)$price; $this->callMethod($id, $price); }
...
- It is forbidden to use a ternary into another ternary (such as
echo ((true ? 'true' : false) ? 't' : 'f');
). - We recommend the use of
&&
and||
into your conditions:echo ('X' == 0 && 'X' == true
- Please don't use reference parameters (such as {{function is_ref_to(&$a, &$b) { ... }}}).
SQL
Table names
Table names must begin with the PrestaShop "DB_PREFIX" prefix.
Code Block borderStyle solid ... FROM `'. _DB_PREFIX_.'customer` ...
- Table names must have the same name as the object they reflect: "ps_cart".
- Table names have to stay singular: "ps_order".
- Language data have to be stored in a table named exactly like the object's table, and with the "_lang" suffix "ps_product_lang".
SQL query
Keywords must be written in uppercase.
Code Block borderStyle solid SELECT `firstname` FROM `'. _DB_PREFIX_.'customer`
Back quotes ("`") must be used around SQL field names and table names.
Code Block borderStyle solid SELECT p.`foo`, c.`bar` FROM `'. _DB_PREFIX_.'product` p, `'. _DB_PREFIX_.'customer` c
Table aliases have to be named by taking the first letter of each word, and must be lowercase.
Code Block borderStyle solid SELECT p.`id_product`, pl.`name` FROM `'. _DB_PREFIX_.'product` p NATURAL JOIN `'. _DB_PREFIX_.'product_lang` pl
When conflicts between table aliases occur, the second character has to be also used in the name.
Code Block borderStyle solid SELECT ca.`id_product`, cu.`firstname` FROM `'.DB_PREFIX.'cart` ca, `'. _DB_PREFIX_.'customer` cu
Indentation has to be done for each clause
Code Block borderStyle solid $query = 'SELECT pl.`name` FROM `'.PS_DBP.'product_lang` pl WHERE pl.`id_product` = 17';
- It is forbidden to make a JOIN in a WHERE clause.
...