Page History

...

Consistency is important, even more so when writing open-source code, since the code belongs to millions on of eyeballs, and bug-fixing relies on this these teeming millions to actually locate bugs and understand how to solve it.

This is why, when writing anything for PrestaShop, be it a theme, a module or a core patch, you should strive to follow the following guidelines. They are the ones that the PrestaShop developers adhere to, and following them is the surest way to have you your code be elegantly integrated in PrestaShop.

...

Use lowercase letters, and separate words using underscores. Do not ever use camelCaseCamelCase.

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.

...

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

   Code Block
   borderStyle solid
   if (<condition>) while (<condition>)

2. When a combination of if and else is used and both can return a value, the else statement has to be omitted.

   Code Block
   borderStyle solid
   if (<condition>) return false; return true;

   Note
   title Recommendation
   We recommend to use only one return statement 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
   borderStyle solid
   public aFirstMethod() { return $this->aSecondMethod(); }

4. Tests must be grouped by entity.

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

...

1. Inside functions and methods, only the "//" comment tag is allowed.

2. After the "//" comment marker, a space is required:

   Code Block
   borderStyle solid
   // My great comment

3. 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

4. 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 ... }

5. A phpDoc 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 information about the PHP Doc syntax: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html.

...

1. All users' 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');

   Note
   getValue() does not protect your code from hacking attempts (SQL injections, XSS flaws and CRSF breaches). You still have to secure your data yourself. One PrestaShop-specific securization method is pSQL($value): it helps protect your database against SQL injections.

2. 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)

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
   borderStyle solid
   protected myProtectedMethod($id, $text, $price) { $this->id = (int)$id; $this->price = (float)$price; $this->callMethod($id, $price); }

...

1. Source code lines are limited to 120 150 characters wide.
2. Functions and methods lines are limited to 80 characters. Functions must have a good reason to have an overly long name: keep it to the essential!

...

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 instead of AND and OR: echo ('X' == 0 && 'X' == true).

3. Please refrain from using reference parameters, such as:

   Code Block
   function is_ref_to(&$a, &$b) { ... }

...

1. Keywords must be written in uppercase.

   Code Block
   borderStyle solid
   SELECT `firstname` FROM `'._DB_PREFIX_.'customer`

2. 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

3. 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

4. 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

5. Indentation A new line has to be done created for each clause.

   Code Block
   borderStyle solid
   $query = 'SELECT pl.`name` FROM `'._DB_PREFIX_.'product_lang` pl WHERE pl.`id_product` = 17';

6. It is forbidden to make a JOIN in a WHERE clause.

...

You can download the PrestaShop code standard using SVNGit:http https://svngithub.prestashop.com/branchesPrestaShop/PrestaShop-norm/-validator (you must perform this step before going any further with this tutorial).

...

1. Go to Settings -> Inspection -> PHP -> PHP Code Sniffer.
2. Set the path to the phpcs executable.
3. Set the coding standard as "PrestaShop" (which is only available if you did put in CodeSniffer's /Standards folder).

Integration to vim

...

Command line (Linux)

You do not have to use Eclipse PhpStorm to use PHP CodeSniffer, you can also install it so that it can be called from the command line.

1. Install PEAR: http://pear.php.net/
   $> apt-get install php-pear
2. Install PHP CodeSniffer in PEAR: http://pear.php.net/package/PHP_CodeSniffer
   $> pear install PHP_CodeSniffer
3. Add the PrestaShop standard that you downloaded from SVN earlier, and place it in PHP CodeSniffer's "Standards" folder.
   $> svn cohttpgit clone https://svngithub.prestashop.com/branchesPrestaShop/PrestaShop-norm-validator //usr/share/php/PHP/CodeSniffer/Standards/Prestashop
4. Set the Prestashop standard as the default one
   $> phpcs --config-set default_standard Prestashop

...