Child pages
  • Development standard

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of contents

Table of Contents
maxLevel2

...

PrestaShop development standard

...

PHP

Variable names

  1. Corresponding to data from databases: $my_var.
  2. Corresponding to algorithm: $my_var.
  3. The visibility of a member variable does not affect its name: private $my_var.

...

Code Block
borderStylesolid

$my_var = 17;
$a = $b;

Operators

  1. "+", "-", "*", "/", "=" and any combination of them (e.g. "/=") need a space between their left and right members.

    Code Block
    borderStylesolid
    
    $a + 17;
    $result = $b / 2;
    $i += 34;
    
  2. "." does not have a space between its left and right members.

    Code Block
    borderStylesolid
    
    echo $a.$b;
    $c = $d.$this->foo();
    
    Note
    titleRecommendation

    For performance reasons, please do not overuse concatenation.

  3. ".=" needs a space between its left and right members.

    Code Block
    borderStylesolid
    
    $a .= 'Debug';
    

Statements

  1. if, elseif, while, for: need a space between the if keyword and the bracket ().

    Code Block
    borderStylesolid
    
    if (<condition>)
    ...
    while (<condition>)
    
  2. When a combination of if and else is used and both can return a value, the else has to be avoided.

    Code Block
    borderStylesolid
    
    if (<condition>)
    	return false;
    return true;
    
    Note
    titleRecommendation

    We recommend one return per method / function

  3. 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
    borderStylesolid
    
    public aFirstMethod()
    {
    	return $this->aSecondMethod();
    }
    
  4. Tests must be grouped by "entity"

    Code Block
    borderStylesolid
    
    if ($price AND !empty($price))
    	...
    if (!Validate::$myObject OR $myObject->id === NULL)
    	...
    

...

  1. The visibility must be defined every time, even when it is a public method.
  2. The order of the method properties should be: visibility static function functionName().

    Code Block
    borderStylesolid
    
    private static function foo()
    

Method / Function names

  1. Method and function names always use CamelCase: begin with a lowercase character and each following words must begin with an uppercase character.

    Code Block
    borderStylesolid
    
    public function myExampleMethodWithALotOfWordsInItsName()
    
  2. Braces introducing method code have to be preceded by a carriage return.

    Code Block
    borderStylesolid
    
    public function myMethod($arg1, $arg2)
    {
    	...
    }
    
  3. Method and function names must be explicit, so function names such as b() or ef()are completely forbidden.

    Info
    titleExceptions

    The only exceptions are the translation function (called l()) and debug the functions (named p() and d()).

...

Code Block
borderStylesolid

protected function myProtectedMethod($arg1, $arg2, $arg3 = null)

Objects / Classes

  1. Object name must be singular.

    Code Block
    borderStylesolid
    
    class Customer
    
  2. Class name must follow the CamelCase practice, except that the first letter is uppercase.

    Code Block
    borderStylesolid
    
    class MyBeautifulClass
    

Defines

  1. Define names must be written in uppercase
  2. Define names have to be prefixed by "PS_" inside the core and module

    Code Block
    borderStylesolid
    
    define('PS_DEBUG', 1);
    define('PS_MODULE_NAME_DEBUG', 1);
    
  3. Define names does not allow none alphabetical characters. Except "_".

...

Code Block
borderStylesolid

echo 'Debug';
$myObj->name = 'Hello '.$name;

...

  1. Inside functions and methods, only the "//" comment tag is allowed.
  2. After the "//" comment marker, a space is required: // Comment.

    Code Block
    borderStylesolid
    
    // My great comment
    
  3. The "//" comment marker is tolerated at the end of a code line.

    Code Block
    borderStylesolid
    
    $a = 17 + 23; // A comment inside my example function
    
  4. Outside of functions and methods, only the "/" and "/" comment markers are allowed.

    Code Block
    borderStylesolid
    
    /* This method is required for compatibility issues */
    public function foo()
    {
    	// Some code explanation right here
    	...
    }
    
  5. PHP Doc comment block is required before the declaration of the method.

    Code Block
    borderStylesolid
    
    /**
     * 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
    titleFor more informations

    For more informations about the PHP Doc syntax: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html

Return values

  1. The return statement does not need brackets, except when it deals with a composed expression.

    Code Block
    borderStylesolid
    
    return $result;
    return ($a + $b);
    return (a() - b());
    return true;
    
  2. The return statement can be used to break out of a function.

    Code Block
    borderStylesolid
    
    return;
    

Call

Function call preceded by a "@" is forbidden but beware with function / method call with login / password or path arguments.

Code Block
borderStylesolid

myfunction()
// In the following example, we put a @ for security reasons
@mysql_connect(...);

Tags

  1. There must be an empty line after the PHP opening tag.

    Code Block
    borderStylesolid
    
    <?php
    
    require_once('my_file.inc.php');
    
  2. The PHP ending tag is forbidden

...

  1. The tabulation character ("
    t") is the only indentation character allowed.
  2. Each indentation level must be represented by a single tabulation character.

    Code Block
    borderStylesolid
    
    function foo($a)
    {
    	if ($a == null)
    		return false;
    	...
    }
    

Array

  1. The arraykeyword must not be followed by a space.

    Code Block
    borderStylesolid
    
    array(17, 23, 42);
    
  2. When too much data is inside an array, the indentation has to follow the following.

    Code Block
    borderStylesolid
    
    $a = array(
    	36 => $b,
    	$c => 'foo',
    	$d => array(17, 23, 42),
    	$e => array(
    		0 => 'zero',
    		1 => $one
    	)
    );
    

...

Code Block
borderStylesolid

if (!$result)
	return false;

for ($i = 0; $i < 17; $i++)
	if ($myArray[$i] == $value)
		$result[] = $myArray[$i];
	else
		$failed++;

Security

  1. All user's data (data entered by users) has to be cast.

    Code Block
    borderStylesolid
    
    $data = Tools::getValue('name');
    
    $myObject->street_number = (int)Tools::getValue('street_number');
    
  2. All method/function's parameters must be typed (when Array or Object) when received.

    Code Block
    borderStylesolid
    
    public myMethod(Array $var1, $var2, Object $var3)
    
  3. 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
    borderStylesolid
    
    protected myProtectedMethod($id, $text, $price)
    {
    	$this->id = (int)$id;
    	$this->price = (float)$price;
    	$this->callMethod($id, $price);
    }
    

...

  1. It is forbidden to use a ternary into another ternary (such as echo ((true ? 'true' : false) ? 't' : 'f');).
  2. We recommend the use of && and || into your conditions: echo ('X' == 0 && 'X' == true
  3. Please don't use reference parameters (such as {{function is_ref_to(&$a, &$b) { ... }}}).

SQL

Table names

  1. Table names must begin with the PrestaShop "DB_PREFIX" prefix.

    Code Block
    borderStylesolid
    
    ... FROM `'. _DB_PREFIX_.'customer` ...
    
  2. Table names must have the same name as the object they reflect: "ps_cart".
  3. Table names have to stay singular: "ps_order".
  4. 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

  1. Keywords must be written in uppercase.

    Code Block
    borderStylesolid
    
    SELECT `firstname`
    FROM `'. _DB_PREFIX_.'customer`
    
  2. Back quotes ("`") must be used around SQL field names and table names.

    Code Block
    borderStylesolid
    
    SELECT p.`foo`, c.`bar`
    FROM `'. _DB_PREFIX_.'product` p, `'. _DB_PREFIX_.'customer` c
    
  3. Table aliases have to be named by taking the first letter of each word, and must be lowercase.

    Code Block
    borderStylesolid
    
    SELECT p.`id_product`, pl.`name`
    FROM `'. _DB_PREFIX_.'product` p
    NATURAL JOIN `'. _DB_PREFIX_.'product_lang` pl
    
  4. When conflicts between table aliases occur, the second character has to be also used in the name.

    Code Block
    borderStylesolid
    
    SELECT ca.`id_product`, cu.`firstname`
    FROM `'.DB_PREFIX.'cart` ca, `'. _DB_PREFIX_.'customer` cu
    
  5. Indentation has to be done for each clause

    Code Block
    borderStylesolid
    
    $query = 'SELECT pl.`name`
    FROM `'.PS_DBP.'product_lang` pl
    WHERE pl.`id_product` = 17';
    
  6. It is forbidden to make a JOIN in a WHERE clause.

...