Table of contents
Table of Contents | ||
---|---|---|
|
Coding Standards
Consistency is important, even more so when writing open-source code, since the code belongs to millions of eyeballs, and bug-fixing relies on these teeming millions to actually locate bugs and understand how to solve it.
...
If use an IDE, you can use the CodeSniffer code validator to help you write better code.
PHP
Variable names
Just like class, method and function names, variable names should be written in English so as to be readable to as many people as possible.
Use lowercase letters, and separate words using underscores. Do not ever use CamelCase for variable names, only for method/function and object/class 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
.
Assignments
- There should be a space between variable and operators:
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';
When testing a boolean variable, do not use a comparison operator, but directly use the value itself, or the value prefixed with an exclamation mark:
Code Block // do not use this if ($var == true) // ...nor this if ($var == false) // use this if ($var) // ...or this if (!$var)
Statements
if
,elseif
,while
,for
: need a space between theif
keyword and the parentheses()
.Code Block borderStyle solid if (<condition>) while (<condition>)
When a combination of
if
andelse
is used and both can return a value, theelse
statement has to be omitted.Code Block borderStyle solid if (<condition>) return false; return true;
Note title Recommendation We recommend you to use only one
return
statement 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 && !empty($price)) ... if (!Validate::$myObject || $myObject->id === NULL) ...
Visibility
- 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 proceeded 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 the debug functions (namedp()
andd()
).
Enumeration
Commas have to be followed (and not preceded) by a space.
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
Constants
- Constant names must be written in uppercase, except for "true", "false" and "null" which must be lowercase:
ENT_NOQUOTE
,true
. Constant names have to be prefixed with "
PS_
" inside the core and module.Code Block borderStyle solid define('PS_DEBUG', 1); define('PS_MODULE_NAME_DEBUG', 1);
- Constant names should only use alphabetical characters and "_".
Keywords
All keywords have to be lowercase: as, case, if, echo, null
.
Configuration variables
Configuration variables follow the same rules as defined above.
Strings
Strings have to be surrounded by simple quotes, never double ones.
Code Block | ||
---|---|---|
| ||
echo 'Debug';
$myObj->name = 'Hello '.$name;
|
Comments
- Inside functions and methods, only the "
//
" comment tag is allowed. After the "
//
" comment marker, a space is required: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 ... }
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.
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
Performing a function call preceded by a "@
" is forbidden, but beware of 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 closing tag is forbidden at the end of a file.
Indentation
- 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 be as follows:
Code Block borderStyle solid $a = array( 36 => $b, $c => 'foo', $d => array(17, 23, 42), $e => array( 0 => 'zero', 1 => $one ) );
Block
Braces are prohibited when they only define one instruction or a combination of statements.
Code Block | ||
---|---|---|
| ||
Note | ||
Starting with version 1.6.1.0, the PrestaShop Core codebase has switched to the PSR-1 coding standard and PSR-2 coding style guide. See the reasons why on the announcement article on the Build PrestaShop deblog. Existing modules and themes are not required to switch to PSR-1 and PSR-2. |
For reference's sake, the old PrestaShop coding standards is kept in this page: Old PrestaShop Coding Standards. Please do not use it.
Table of contents
Table of Contents | ||
---|---|---|
|
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.
PSR-1 - Basic Coding Standard
1. Overview
Files MUST use only
<?php
and<?=
tags.Files MUST use only UTF-8 without BOM for PHP code.
Files SHOULD either declare symbols (classes, functions, constants, etc.) or cause side-effects (e.g. generate output, change .ini settings, etc.) but SHOULD NOT do both.
Namespaces and classes MUST follow an "autoloading" PSR: [PSR-0, PSR-4].
Class names MUST be declared in
StudlyCaps
.Class constants MUST be declared in all upper case with underscore separators.
Method names MUST be declared in
camelCase
.
2. Files
2.1. PHP Tags
PHP code MUST use the long <?php ?>
tags or the short-echo <?= ?>
tags; it MUST NOT use the other tag variations.
2.2. Character Encoding
PHP code MUST use only UTF-8 without BOM.
2.3. Side Effects
A file SHOULD declare new symbols (classes, functions, constants, etc.) and cause no other side effects, or it SHOULD execute logic with side effects, but SHOULD NOT do both.
The phrase "side effects" means execution of logic not directly related to declaring classes, functions, constants, etc., merely from including the file.
"Side effects" include but are not limited to: generating output, explicit use of require
or include
, connecting to external services, modifying ini settings, emitting errors or exceptions, modifying global or static variables, reading from or writing to a file, and so on.
The following is an example of a file with both declarations and side effects; i.e, an example of what to avoid:
Code Block |
---|
<?php
// side effect: change ini settings
ini_set('error_reporting', E_ALL);
// side effect: loads a file
include "file.php";
// side effect: generates output
echo "<html>\n";
// declaration
function foo()
{
// function body
} |
The following example is of a file that contains declarations without side effects; i.e., an example of what to emulate:
Code Block |
---|
<?php
// declaration
function foo()
{
// function body
}
// conditional declaration is *not* a side effect
if (! function_exists('bar')) {
function bar()
{
// function body
}
} |
3. Namespace and Class Names
Namespaces and classes MUST follow an "autoloading" PSR: [PSR-0, PSR-4].
This means each class is in a file by itself, and is in a namespace of at least one level: a top-level vendor name.
Class names MUST be declared in StudlyCaps
.
Code written for PHP 5.3 and after MUST use formal namespaces.
For example:
Code Block |
---|
<?php
// PHP 5.3 and later:
namespace Vendor\Model;
class Foo
{
} |
Code written for 5.2.x and before SHOULD use the pseudo-namespacing convention of Vendor_
prefixes on class names.
Code Block |
---|
<?php
// PHP 5.2.x and earlier:
class Vendor_Model_Foo
{
} |
4. Class Constants, Properties, and Methods
The term "class" refers to all classes, interfaces, and traits.
4.1. Constants
Class constants MUST be declared in all upper case with underscore separators. For example:
Code Block |
---|
<?php
namespace Vendor\Model;
class Foo
{
const VERSION = '1.0';
const DATE_APPROVED = '2012-06-01';
} |
4.2. Properties
This guide intentionally avoids any recommendation regarding the use of $StudlyCaps
, $camelCase
, or $under_score
property names.
Whatever naming convention is used SHOULD be applied consistently within a reasonable scope. That scope may be vendor-level, package-level, class-level, or method-level.
4.3. Methods
Method names MUST be declared in camelCase()
.
PSR-2 - Coding Style Guide
1. Overview
Code MUST follow a "coding style guide" PSR [PSR-1].
Code MUST use 4 spaces for indenting, not tabs.
There MUST NOT be a hard limit on line length; the soft limit MUST be 120 characters; lines SHOULD be 80 characters or less.
There MUST be one blank line after the
namespace
declaration, and there MUST be one blank line after the block ofuse
declarations.Opening braces for classes MUST go on the next line, and closing braces MUST go on the next line after the body.
Opening braces for methods MUST go on the next line, and closing braces MUST go on the next line after the body.
Visibility MUST be declared on all properties and methods;
abstract
andfinal
MUST be declared before the visibility;static
MUST be declared after the visibility.Control structure keywords MUST have one space after them; method and function calls MUST NOT.
Opening braces for control structures MUST go on the same line, and closing braces MUST go on the next line after the body.
Opening parentheses for control structures MUST NOT have a space after them, and closing parentheses for control structures MUST NOT have a space before.
1.1. Example
This example encompasses some of the rules below as a quick overview:
Code Block |
---|
<?php
namespace Vendor\Package;
use FooInterface;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class Foo extends Bar implements FooInterface
{
public function sampleFunction($a, $b = null)
{
if ($a === $b) {
bar();
} elseif ($a > $b) {
$foo->bar($arg1);
} else {
BazClass::bar($arg2, $arg3);
}
}
final public static function bar()
{
// method body
}
} |
2. General
2.1 Basic Coding Standard
Code MUST follow all rules outlined in PSR-1.
2.2 Files
All PHP files MUST use the Unix LF (linefeed) line ending.
All PHP files MUST end with a single blank line.
The closing ?>
tag MUST be omitted from files containing only PHP.
2.3. Lines
There MUST NOT be a hard limit on line length.
The soft limit on line length MUST be 120 characters; automated style checkers MUST warn but MUST NOT error at the soft limit.
Lines SHOULD NOT be longer than 80 characters; lines longer than that SHOULD be split into multiple subsequent lines of no more than 80 characters each.
There MUST NOT be trailing whitespace at the end of non-blank lines.
Blank lines MAY be added to improve readability and to indicate related blocks of code.
There MUST NOT be more than one statement per line.
2.4. Indenting
Code MUST use an indent of 4 spaces, and MUST NOT use tabs for indenting.
Note |
---|
Using only spaces, and not mixing spaces with tabs, helps to avoid problems with diffs, patches, history, and annotations. The use of spaces also makes it easy to insert fine-grained sub-indentation for inter-line alignment. |
2.5. Keywords and True/False/Null
PHP keywords MUST be in lower case.
The PHP constants true
, false
, and null
MUST be in lower case.
3. Namespace and Use Declarations
When present, there MUST be one blank line after the namespace
declaration.
When present, all use
declarations MUST go after the namespace
declaration.
There MUST be one use
keyword per declaration.
There MUST be one blank line after the use
block.
For example:
Code Block |
---|
<?php
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
// ... additional PHP code ... |
4. Classes, Properties, and Methods
The term "class" refers to all classes, interfaces, and traits.
4.1. Extends and Implements
The extends
and implements
keywords MUST be declared on the same line as the class name.
The opening brace for the class MUST go on its own line; the closing brace for the class MUST go on the next line after the body.
Code Block |
---|
<?php
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class ClassName extends ParentClass implements \ArrayAccess, \Countable
{
// constants, properties, methods
}
Lists of implements
MAY be split across multiple lines, where each subsequent line is
indented once. When doing so, the first item in the list MUST be on the
next line, and there MUST be only one interface per line.
<?php
namespace Vendor\Package;
use FooClass;
use BarClass as Bar;
use OtherVendor\OtherPackage\BazClass;
class ClassName extends ParentClass implements
\ArrayAccess,
\Countable,
\Serializable
{
// constants, properties, methods
} |
4.2. Properties
Visibility MUST be declared on all properties.
The var
keyword MUST NOT be used to declare a property.
There MUST NOT be more than one property declared per statement.
Property names SHOULD NOT be prefixed with a single underscore to indicate protected or private visibility.
A property declaration looks like the following.
Code Block |
---|
<?php
namespace Vendor\Package;
class ClassName
{
public $foo = null;
} |
4.3. Methods
Visibility MUST be declared on all methods.
Method names SHOULD NOT be prefixed with a single underscore to indicate protected or private visibility.
Method names MUST NOT be declared with a space after the method name. The opening brace MUST go on its own line, and the closing brace MUST go on the next line following the body. There MUST NOT be a space after the opening parenthesis, and there MUST NOT be a space before the closing parenthesis.
A method declaration looks like the following. Note the placement of parentheses, commas, spaces, and braces:
Code Block |
---|
<?php
namespace Vendor\Package;
class ClassName
{
public function fooBarBaz($arg1, &$arg2, $arg3 = [])
{
// method body
}
} |
4.4. Method Arguments
In the argument list, there MUST NOT be a space before each comma, and there MUST be one space after each comma.
Method arguments with default values MUST go at the end of the argument list.
Code Block |
---|
<?php
namespace Vendor\Package;
class ClassName
{
public function foo($arg1, &$arg2, $arg3 = [])
{
// method body
}
} |
Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.
When the argument list is split across multiple lines, the closing parenthesis and opening brace MUST be placed together on their own line with one space between them.
Code Block |
---|
<?php
namespace Vendor\Package;
class ClassName
{
public function aVeryLongMethodName(
ClassTypeHint $arg1,
&$arg2,
array $arg3 = []
) {
// method body
}
} |
4.5. abstract
, final
, and static
When present, the abstract
and final
declarations MUST precede the visibility declaration.
When present, the static
declaration MUST come after the visibility declaration.
Code Block |
---|
<?php
namespace Vendor\Package;
abstract class ClassName
{
protected static $foo;
abstract protected function zim();
final public static function bar()
{
// method body
}
} |
4.6. Method and Function Calls
When making a method or function call, there MUST NOT be a space between the method or function name and the opening parenthesis, there MUST NOT be a space after the opening parenthesis, and there MUST NOT be a space before the closing parenthesis. In the argument list, there MUST NOT be a space before each comma, and there MUST be one space after each comma.
Code Block |
---|
<?php
bar();
$foo->bar($arg1);
Foo::bar($arg2, $arg3); |
Argument lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument per line.
Code Block |
---|
<?php
$foo->bar(
$longArgument,
$longerArgument,
$muchLongerArgument
); |
5. Control Structures
The general style rules for control structures are as follows:
- There MUST be one space after the control structure keyword
- There MUST NOT be a space after the opening parenthesis
- There MUST NOT be a space before the closing parenthesis
- There MUST be one space between the closing parenthesis and the opening brace
- The structure body MUST be indented once
- The closing brace MUST be on the next line after the body
The body of each structure MUST be enclosed by braces. This standardizes how the structures look, and reduces the likelihood of introducing errors as new lines get added to the body.
5.1. if
, elseif
, else
An if
structure looks like the following. Note the placement of parentheses, spaces, and braces; and that else
and elseif
are on the same line as the closing brace from the earlier body.
Code Block |
---|
<?php
if ($expr1) {
// if body
} elseif ($expr2) {
// elseif body
} else {
// else body;
} |
The keyword elseif
SHOULD be used instead of else if
so that all control keywords look like single words.
5.2. switch
, case
A switch
structure looks like the following. Note the placement of parentheses, spaces, and braces. The case
statement MUST be indented once from switch
, and the break
keyword (or other terminating keyword) MUST be indented at the same level as the case
body. There MUST be a comment such as // no break
when fall-through is intentional in a non-empty case
body.
Code Block |
---|
<?php
switch ($expr) {
case 0:
echo 'First case, with a break';
break;
case 1:
echo 'Second case, which falls through';
// no break
case 2:
case 3:
case 4:
echo 'Third case, return instead of break';
return;
default:
echo 'Default case';
break;
} |
5.3. while
, do while
A while
statement looks like the following. Note the placement of parentheses, spaces, and braces.
Code Block |
---|
<?php
while ($expr) {
// structure body
} |
Similarly, a do while
statement looks like the following. Note the placement of parentheses, spaces, and braces.
Code Block |
---|
<?php
do {
// structure body;
} while ($expr); |
5.4. for
A for
statement looks like the following. Note the placement of parentheses, spaces, and braces.
Code Block |
---|
<?php for ($i = 0; $i < 1710; $i++) { // for if ($myArray[$i] ==body } |
5.5. foreach
A foreach
statement looks like the following. Note the placement of parentheses, spaces, and braces.
Code Block |
---|
<?php foreach ($iterable as $key => $value) { // foreach body } |
5.6. try
, catch
A try catch
block looks like the following. Note the placement of parentheses, spaces, and braces.
Code Block |
---|
<?php try { // try body } catch (FirstExceptionType $e) $result[]{ = $myArray[$i]; return $result; } else $failed++; |
Security
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 ispSQL($value)
: it helps protect your database against SQL injections.All method/function's parameters must be typed (when
Array
orObject
) 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); }
Limitations
- Source code lines are limited to 150 characters wide.
- 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!
Other
- 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 instead ofAND
andOR
:echo ('X' == 0 && 'X' == true)
. Please refrain from using reference parameters, such as:
Code Block function is_ref_to(&$a, &$b) { ... }
...
// catch body
} catch (OtherExceptionType $e) {
// catch body
} |
6. Closures
Closures MUST be declared with a space after the function
keyword, and a space before and after the use
keyword.
The opening brace MUST go on the same line, and the closing brace MUST go on the next line following the body.
There MUST NOT be a space after the opening parenthesis of the argument list or variable list, and there MUST NOT be a space before the closing parenthesis of the argument list or variable list.
In the argument list and variable list, there MUST NOT be a space before each comma, and there MUST be one space after each comma.
Closure arguments with default values MUST go at the end of the argument list.
A closure declaration looks like the following. Note the placement of parentheses, commas, spaces, and braces:
Code Block |
---|
<?php
$closureWithArgs = function ($arg1, $arg2) {
// body
};
$closureWithArgsAndVars = function ($arg1, $arg2) use ($var1, $var2) {
// body
}; |
Argument lists and variable lists MAY be split across multiple lines, where each subsequent line is indented once. When doing so, the first item in the list MUST be on the next line, and there MUST be only one argument or variable per line.
When the ending list (whether or arguments or variables) is split across multiple lines, the closing parenthesis and opening brace MUST be placed together on their own line with one space between them.
The following are examples of closures with and without argument lists and variable lists split across multiple lines.
Code Block |
---|
<?php
$longArgs_noVars = function (
$longArgument,
$longerArgument,
$muchLongerArgument
) {
// body
};
$noArgs_longVars = function () use (
$longVar1,
$longerVar2,
$muchLongerVar3
) {
// body
};
$longArgs_longVars = function (
$longArgument,
$longerArgument,
$muchLongerArgument
) use (
$longVar1,
$longerVar2,
$muchLongerVar3
) {
// body
};
$longArgs_shortVars = function (
$longArgument,
$longerArgument,
$muchLongerArgument
) use ($var1) {
// body
};
$shortArgs_longVars = function ($arg) use (
$longVar1,
$longerVar2,
$muchLongerVar3
) {
// body
}; |
Note that the formatting rules also apply when the closure is used directly in a function or method call as an argument.
Code Block |
---|
<?php
$foo->bar(
$arg1,
function ($arg2) use ($var1) {
// body
},
$arg3
); |
SQL Guidelines
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
".
...
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
A new line has to be created for each clause.
Code Block borderStyle solid $query = 'SELECT pl.`name` FROM `'._DB_PREFIX_.'product_lang` pl WHERE pl.`id_product` = 17';
- It is forbidden to make a
JOIN
in aWHERE
clause.
...
About the code validator (PHP CodeSniffer)
This is a brief tutorial on how to install a code validator on your PC and use it to validate your files. The code validator uses PHP CodeSniffer, which is a PEAR package (http://pear.php.net/package/PHP_CodeSniffer/). The PrestaShop code standard was created specifically for CodeSniffer, using many rules taken from existing standards, with added customized rules in order to better fit our project.
You can download the PrestaShop code standard using Git: https://github.com/PrestaShop/PrestaShop-norm-validator (you must perform this step before going any further with this tutorial).
Info |
---|
In order for it to be recognized as a basic standard, it must be placed in the CodeSniffer's / Standards folder |
PhpStorm integration
If you use PhpStorm (http://www.jetbrains.com/phpstorm/), follow these steps:
- Go to Settings -> Inspection -> PHP -> PHP Code Sniffer.
- Set the path to the
phpcs
executable. - Set the coding standard as "PrestaShop" (which is only available if you did put in CodeSniffer's
/Standards
folder).
Integration to vim
Several plugins are available online. For instance, you can use this one: https://github.com/bpearson/vim-phpcs/blob/master/plugin/phpcs.vim
Put in your ~/.vim/plugin
folder.
You can add two shortcuts (for instance, F9 to display everything and Ctrl+F9 to hide warnings) in your .vimrc
file in normal and insert mode:
Code Block |
---|
nmap <C-F9>:CodeSniffErrorOnly<CR>
imap <C-F9> <Esc>:CodeSniffErrorOnly<CR>
nmap <F9>:CodeSniff<CR>
imap <F9> <Esc>:CodeSniff<CR>a |
Command line (Linux)
You do not have to use PhpStorm to use PHP CodeSniffer, you can also install it so that it can be called from the command line.
- Install PEAR: http://pear.php.net/
$> apt-get install php-pear
- Install PHP CodeSniffer in PEAR: http://pear.php.net/package/PHP_CodeSniffer
$> pear install PHP_CodeSniffer
- Add the PrestaShop standard that you downloaded from SVN earlier, and place it in PHP CodeSniffer's "Standards" folder.
$> git clone https://github.com/PrestaShop/PrestaShop-norm-validator
/usr/share/php/PHP/CodeSniffer/Standards/Prestashop
- Set the Prestashop standard as the default one
$> phpcs --config-set default_standard Prestashop
The various options for this command are well explained in its documentation. For now, here is the easy way to launch it:
Code Block |
---|
$> phpcs --standard=/path/to/norm/Prestashop /folder/or/fileToCheck |
In order to only display errors, not warnings:
Code Block |
---|
$> phpcs --standard=/path/to/norm/Prestashop --warning-severity=99 /folder/or/fileToCheck |
If you have already manually installed PHP CodeSniffer, the program should be in PEAR's /scripts
folder.
Note | ||
---|---|---|
Windows users: although the
|
CodeSniffer configuration file is not yet available. Thank you for your patience!