Типы файлов и кодировка
Все файлы PHP, за исключением файлов представления/шаблонов, имеют расширение.php.Все файлы представлений/шаблонов имеют расширение
.twig.Переносы строк обрабатываются Git автоматически, репозиторий управляется с помощью LF. При клонировании все переводы строк будут автоматически преобразованы в Вашу родную среду (CRLF для Windows, LF для Mac/Linux).
Теги PHP
Короткие открывающие теги PHP и теги ASP не поддерживаются. Символы должны быть строчными.
Открывающий тег:
<?php
Закрывающий тег:
?>Отступ
Файлы PHP должны иметь отступ с помощью ТАБУЛЯЦИИ. 4 пробела не поддерживаются.HTML в файлах шаблонов (
.twig) должен иметь отступ в 2 пробела, а не 4 пробела или ТАБЫ. JavaScript должен иметь отступ с помощью символа ТАБУЛЯЦИИ.Интервал
IF, WHILE, FOR и остальные должны иметь пробел до и после скобок.
Пример правильного кода:
if () {
Пример неправильного кода:
if(){В ELSE и аналогичных должны быть пробел после и перед фигурными скобками.
Пример правильного кода:
} else {
Пример неправильного кода:
}else{При приведении типов НЕТ пробела перед переменной
Пример правильного кода:
(int)$var
Пример неправильного кода:
(int) $varПри установке переменной всегда должен быть пробел до и после знака равенства.
Пример правильного кода:
$var = 1;
Пример неправильного кода:
$var=1;Пробел
После любого кода, но перед новой строкой - пробелов быть не должно. То же самое и с пустой строкой.После закрывающего тега PHP очень важно удалить все пробелы.
Новые линии
Открывающие фигурные скобки не переходят на новую строку, перед ними всегда будет пробел и они будут на той же строке.1 стиль True Brace (1TBS) (WIKI)
Пример правильного кода:
if ($my_example == 1) {
class ModelExampleExample extends Model {
public function addExample() {
} else {
Пример неправильного кода:
if ($my_example == 1)
{
class ModelExampleExample extends Model
{
public function addExample()
{
}
else
{Именование файлов
Все файлы должны быть в нижнем регистре и слова разделены подчеркиванием.Именование классов и методов
Имена классов и имена методов должны быть написаны в верблюжьем регистре.
Пример правильного кода:
class ModelExampleExample extends Model
public function addExample()
Пример неправильного кода:
class model_exampleexample extends Model
public function add_example()Область метода всегда должна быть приведена.
Пример правильного кода:
public function addExample()
Пример неправильного кода:
function addExample()Именование функций PHP (помощников)
Имена вспомогательных функций должны быть в нижнем регистре, а слова должны разделяться знаком подчеркивания.Именование переменных PHP
Переменные PHP должны быть в нижнем регистре, а для разделения слов используется подчеркивание.
Пример правильного кода:
$var = 123;
$new_var = 12345;
Пример неправильного кода:
$Var = 123;
$newVar = 12345;Константы, определяемые пользователем
Константы, определяемые пользователем, вводятся в верхнем регистре.
Пример правильного кода:
define('MY_VAR', 'My constant string value');
Пример неправильного кода:
define('my_var', 'My constant string value');Константы PHP
Эти типы констант (true, false, null) устанавливаются в нижнем регистре.
Пример правильного кода:
$my_var = true;
Пример неправильного кода:
$my_var = TRUE;HTML / CSS правила
Имена классов и идентификаторы должны переноситься через дефис и не использовать подчеркивание.
Пример правильного кода:
class="my-class"
Пример неправильного кода:
class="my_class"PHP CodeSniffer
Здесь есть стандарт PHP_CodeSniffer: https://github.com/opencart/opencart/tree/master/tests/phpcs/OpenCartВы можете использовать это с командой в следующих строках, если у Вас установлен PHP_CodeSniffer:
Код:
phpcs --standard=phpcs.xml opencart
Последнее редактирование: