Загрузка...

Немного могли изменится с выходом PrestaShop 1.6.1

Стандарты программирования

Последовательность важна, тем более, при написании open source проектов, так как множество людей их читают именно поэтому Ваш код должен быть прост и понятен другим.

Если Вы используете IDE, попробуйте phpSniffer, для того чтобы быстрее и лучше писать код.

PHP

Имена переменных

Должны быть написаны на англ. языке, в именах переменных не должен использоваться синтаксис CamelCase, т.к. CamelCase используются для обозначения классов.

В соответствии с данными из базы данных: $my_var .
В соответствии с алгоритмом: $my_var .
Видимость переменной-члена не влияет на его имя: private $my_var .

Задания

Соблюдайте пробел между переменными и операторами:

My_var = $ 17 ;
$ = $ B;

1 2	My_var = $ 17 ; $ = $ B;

Операторы

Соблюдайте пробел между операторами ” + “,” – “,” * “,” / “,” = “, и любая комбинация из них (например,” / = “) .

+ $ 17 ; Результат = $ $ б / 2 ; $ I + = 34 ;

1
2
3

+ $ 17 ;
Результат = $ $ б / 2 ;
$ I + = 34 ;
” . ” не ставьте пробел между переменными.

echo $a.$b; $c = $d.$this->foo();

1
2

echo $a.$b;
$c = $d.$this->foo();

Для повышения производительности, пожалуйста, не злоупотребляйте конкатенации.
” . = “нужен пробел между переменной и точкой

$a .= 'Debug';

1

$a .= 'Debug';
При тестировании логической переменной, не используйте оператор сравнения, а непосредственно использовать само значение, или значение префикса с восклицательным знаком:

// do not use this if ($var == true) // ...nor this if ($var == false) // use this if ($var) // ...or this if (!$var)

1
2
3
4
5
6
7
8
9

// do not use this
if ($var == true)
// ...nor this
if ($var == false)

// use this
if ($var)
// ...or this
if (!$var)

Условные конструкции

if , elseIf используйте пробел после их применения.

if (<condition>) while (<condition>)

1
2
3

if (<condition>)

while (<condition>)
Когда используются в комбинации конструкция else может быть опущена.

if (<condition>) return false; return true;

1
2
3

if (<condition>)
return false;
return true;

Рекомендация
Возвращайте одно значение у метода / функции.
Когда метод / функция возвращает логический и текущий метод / функции ее лучше избегать.

public aFirstMethod() { return $this->aSecondMethod(); }

1
2
3
4

public aFirstMethod()
{
return $this->aSecondMethod();
}
Испытания должны быть сгруппированы по сущности.

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

1
2
3
4

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

Область видимости

Видимость должна быть определена каждый раз, даже если это открытый метод.
Порядок свойств метода должно быть: visibility static function FunctionName () .

private static function foo()

1

private static function foo()

Методы / Имена функций

Для названия методов и имен функций применяйте CamelCase: каждое следующее слово должно начинаться с большой буквы.

public function myExampleMethodWithALotOfWordsInItsName()

1

public function myExampleMethodWithALotOfWordsInItsName()
Скобки должны начинаться с новой строки.

public function myMethod($arg1, $arg2) { ... }

1
2
3
4

public function myMethod($arg1, $arg2)
{
...
}
Метод и имена функций должны быть явными, поэтому имена функций, таких как b () или ef() настоятельно не рекомендуются исключением являются функции вызова и дебага.

Перечисление

Запятые должны стоять перед пробелами.

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

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

Объекты / Классы

Имя объекта должно состоять из одного слова.

class Customer

1

class Customer
Имя классов должны быть написаны CamelCase (верблюжьей нотацией), первая буква должна быть в верхнем регистре.

class MyBeautifulClass

1

class MyBeautifulClass

Константы

Имена констант должны быть написаны в верхнем регистре, за исключением “true”, “false” and “null”, которые должны быть в нижнем регистре: ENT_NOQUOTE, true.
Имена констант должны быть с префиксом “ PS_” внутри ядра и модулей.

define('PS_DEBUG', 1); define('PS_MODULE_NAME_DEBUG', 1);

1
2

define('PS_DEBUG', 1);
define('PS_MODULE_NAME_DEBUG', 1);
Имена констант должны использовать только буквы алфавита и “_” (символы подчеркивания).

Ключевые слова

Все ключевые слова должны быть в нижнем регистре: as, case, if, echo, null.

Переменные

Переменных следуют тем же правилам, описанными выше.

Строки

Строки должны быть в одинарных кавычках, не в двойных.

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

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

Внутри функций и методов, допускаются только комментарии ” / / “.
После символа ” / / ” комментария, ставится пробел:

// My great comment

1

// My great comment
” / / “комментарий должен идти после кода.

$a = 17 + 23; // A comment inside my example function

1

$a = 17 + 23; // A comment inside my example function
Вне функции и методы, допускаются только такие комментарии ” / * “и” * / “.

/* This method is required for compatibility issues */ public function foo() { // Some code explanation right here ... }

1
2
3
4
5
6

/* This method is required for compatibility issues */
public function foo()
{
// Some code explanation right here
...
}

PHPDoc необходимо описывать методы перед их определением.

/**
 * 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)

/**

* 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)

Внимание!

Для получения дополнительной информации о синтаксисе PHP Doc: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html .

Возврат функции

При возврате функции круглые скобки не требуются, кроме тех случаев, когда происходит вычисление выражения.

return $result; return ($a + $b); return (a() - b()); return true;

1
2
3
4

return $result;
return ($a + $b);
return (a() - b());
return true;
Чтобы выйти из функции используйте return.

return;

1

return;

Вызов функций

прямой вызов функций запрещен ” @ “, никогда не вызываете методы и функции напрямую.

myfunction();

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

myfunction();

// In the following example, we put a @ for security reasons

@mysql_connect(...);

Тэги

Оставляйте пустую строку, после тега PHP.

<?php require_once('my_file.inc.php');

1
2
3

<?php

require_once('my_file.inc.php');
Закрывающий тег не нужен в конце файла т.к. после него могут идти другие файлы.

Отступ

Для отступов используйте символ табуляции TAB (“ \t”).
Каждый уровень отступа должен быть представлен один символ табуляции.

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

1
2
3
4
5
6

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

Массив

После массива не требуется отступ.

array(17, 23, 42);

1

array(17, 23, 42);

Когда слишком много данных в массиве, отступ должен быть следующим:

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

$a = array(

36 => $b,

$c => 'foo',

$d => array(17, 23, 42),

$e => array(

0 => 'zero',

1 => $one

)

);

Скобки

Круглые скобки запрещены, если они не определяют инструкцию или комбинацию.

if (!$result)
    return false;

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

if (!$result)

return false;

for ($i = 0; $i < 17; $i++)

if ($myArray[$i] == $value)

{

$result[] = $myArray[$i];

return $result;

}

else

$failed++;

Безопасность

Все данные пользователей (данные, введенные пользователем) должен быть защищены.

$data = Tools::getValue('name'); $myObject->street_number = (int)Tools::getValue('street_number');

1
2
3

$data = Tools::getValue('name');

$myObject->street_number = (int)Tools::getValue('street_number');

Внимание!

getValue() не защитит ваш код от попыток взлома (SQL инъекции, XSS и нарушений CRSF). Вы должны подумать о защите самостоятельно.
Один из методов безопасности PrestaShop pSQL($value): помогает защитить вашу базу данных от SQL инъекций.
Все методы / функции ‘с параметрами должны быть напечатаны (когда массив или объект ), когда получил.

public myMethod(Array $var1, $var2, Object $var3)

1

public myMethod(Array $var1, $var2, Object $var3)
Для всех остальных параметров, они должны быть поданы каждый раз, когда они используются, кроме случаев, когда они направляются на другие методы / функции.

protected myProtectedMethod($id, $text, $price) { $this->id = (int)$id; $this->price = (float)$price; $this->callMethod($id, $price); }

1
2
3
4
5
6

protected myProtectedMethod($id, $text, $price)
{
    $this->id = (int)$id;
    $this->price = (float)$price;
    $this->callMethod($id, $price);
}

Лимиты

Строки ограничены 120 символами.
Функции и методы ограничены до 80 символов. Должны быть очень веские причины, называть функцию длиннее 80 символов !

Другой

Запрещается использовать тройные в другой тройных, таких, как echo ((true ? 'true' : false) ? 't' : 'f');.
Мы рекомендуем использовать && и | | в условных конструкциях: echo (‘X’ == 0 && ‘X’ == TRUE) .
Пожалуйста, воздержитесь от использования ссылок на объекты, таких как:

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

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

SQL

Имена таблиц

Имена таблиц должны начинаться с PrestaShop ” _DB_PREFIX_ “префикс.

... FROM `'. _DB_PREFIX_.'customer` ...

1	... FROM `'. _DB_PREFIX_.'customer` ...

Имена таблиц должны иметь то же имя, что и объект: ” ps_cart “.
Имена таблиц должны остаться уникальными: ” ps_order “.
Перевод должен храниться в таблице с именем, как таблица объекта, и с ” _lang ” приставки:” ps_product_lang “.

SQL запросов

Ключевые слова должны быть написаны в верхнем регистре.

SELECT `firstname`
FROM `'._DB_PREFIX_.'customer`

1 2	SELECT `firstname` FROM `'._DB_PREFIX_.'customer`

Поля, таблицы, имена должны экранироваться кавычками (” ` “)

SELECT p.`foo`, c.`bar`
FROM `'._DB_PREFIX_.'product` p, `'._DB_PREFIX_.'customer` c

1 2	SELECT p.`foo`, c.`bar` FROM `'._DB_PREFIX_.'product` p, `'._DB_PREFIX_.'customer` c

Псевдонимы должны использовать первые буквы таблиц с которых они взяты.

SELECT p.`id_product`, pl.`name`
FROM `'._DB_PREFIX_.'product` p
NATURAL JOIN `'._DB_PREFIX_.'product_lang` pl

SELECT p.`id_product`, pl.`name`

FROM `'._DB_PREFIX_.'product` p

NATURAL JOIN `'._DB_PREFIX_.'product_lang` pl

Если происходит конфликт в названии таблиц (такой псевдоним уже существует) используйте 2 букву.

SELECT ca.`id_product`, cu.`firstname`
FROM `'._DB_PREFIX_.'cart` ca, `'._DB_PREFIX_.'customer` cu

1 2	SELECT ca.`id_product`, cu.`firstname` FROM `'._DB_PREFIX_.'cart` ca, `'._DB_PREFIX_.'customer` cu

Отступы должно быть сделаны для каждого пункта.

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

$query = 'SELECT pl.`name`

FROM `'._DB_PREFIX_.'product_lang` pl

WHERE pl.`id_product` = 17';

Запрещается делать JOIN в WHERE.

Установка кода валидатором (PHP phpSniffer)

Это краткое руководство по установке валидатора кода на ваш компьютер и использование его. Для проверки кода PHP используется phpSniffer, который является пакетом PEAR ( http://pear.php.net/package/PHP_phpSniffer/ ). PrestaShop был создан специально для phpSniffer, используя многие правила взяты из существующих стандартов, с добавлением настраиваемые правила для того, чтобы лучше соответствовать нашему проекту.

Вы можете скачать PrestaShop с помощью SVN: https://github.com/PrestaShop/PrestaShop-norm-validator (вы должны выполнить этот шаг, прежде чем двигаться дальше в этом уроке).

Внимание!

Для того, чтобы он был признан в качестве основного стандарта , он должен быть помещен в phpSniffer / В папку по умолчанию.

PhpStorm

Если вы используете PhpStorm ( http://www.jetbrains.com/phpstorm/ ), выполните следующие действия:

Перейдите в раздел Настройки -> Инспекции -> PHP -> PHP код Sniffer.
Установите путь к phpcs.
Установите стандарт кодирования как в “PrestaShop” (которая доступна только если вы действительно размещал phpSniffer / Папку по умолчанию).

Интеграция в Vim

Некоторые плагины доступны в Интернете. Например, вы можете использовать этот: https://github.com/bpearson/vim-phpcs/blob/master/plugin/phpcs.vim
Положить в ~ / .vim / плагин папку.

Вы можете добавить два ярлыка (например, F9, чтобы отобразить все и Ctrl + F9, чтобы скрыть предупреждения) в вашем vimrc. файл в нормальном и режиме вставки:

nmap <C-F9>:CodeSniffErrorOnly<CR>
imap <C-F9> <Esc>:CodeSniffErrorOnly<CR>
nmap <F9>:CodeSniff<CR>

imap <F9> <Esc>:CodeSniff<CR>a

nmap <C-F9>:CodeSniffErrorOnly<CR>

imap <C-F9> <Esc>:CodeSniffErrorOnly<CR>

nmap <F9>:CodeSniff<CR>

imap <F9> <Esc>:CodeSniff<CR>a

Командной строки (Linux)

Вы не должны использовать Eclipse, использовать phpSniffer, вы также можете установить его так, что он может быть вызван из командной строки.

Установите PEAR: http://pear.php.net/
$> APT-получить установку PHP-груша
Установите PHP phpSniffer в PEAR: http://pear.php.net/package/PHP_phpSniffer
$> груши установки PHP_phpSniffer
Добавить PrestaShop стандарт, который вы загрузили с SVN ранее, и поместить его в PHP phpSniffer в “стандартах” папку. $> SVN сотрудничестваhttp://svn.prestashop.com/branches/norm/ / USR / доли / PHP / PHP / phpSniffer / Стандарты / Prestashop
Установите Prestashop стандарта как по умолчанию $> phpcs – конфигурации-default_standard установить Prestashop

Различные варианты этой команды хорошо объяснено в документации к нему. Пока, вот это самый простой способ, чтобы запустить его:

$> phpcs --standard=/path/to/norm/Prestashop /folder/or/fileToCheck

1	$> phpcs --standard=/path/to/norm/Prestashop /folder/or/fileToCheck

Для того, чтобы отображать только ошибки, а не предупреждения:

$> phpcs --standard=/path/to/norm/Prestashop --warning-severity=99 /folder/or/fileToCheck

1	$> phpcs --standard=/path/to/norm/Prestashop --warning-severity=99 /folder/or/fileToCheck

Если вы уже установили вручную phpSniffer PHP, программа должна быть в в PEAR / скрипты папку.

Внимание!

Пользователям Windows: хотя phpcs.bat файл должен быть в этой / скрипты папку, вы, возможно, придется изменить его для того, чтобы работать должным образом (заменить пути с вашим):

path/to/php.exe -d auto_apprend_file="" -d auto_prepend_file -d include_path="path/to/PEAR/" path/to/pear/scripts/phpcs

1	path/to/php.exe -d auto_apprend_file="" -d auto_prepend_file -d include_path="path/to/PEAR/" path/to/pear/scripts/phpcs

Перевод выполнен Saerty.
Если вы заметили ошибку, пожалуйста дайте знать.
Источник: офф сайт

Мне нравится

Стандарты программирования

Стандарты программирования

PHP

Имена переменных

Задания

Операторы

Условные конструкции

Область видимости

Методы / Имена функций

Перечисление

Объекты / Классы

Константы

Ключевые слова

Переменные

Строки

Комментарии

Возврат функции

Вызов функций

Тэги

Отступ

Массив

Скобки

Безопасность

Лимиты

Другой

SQL

Имена таблиц

SQL запросов

Установка кода валидатором (PHP phpSniffer)

PhpStorm

Интеграция в Vim

Похожие статьи

Коментарии0 новых