PSR-12: Расширенный стандарт кодирования

PSR-12 - это стандарт кодирования, который расширяет и заменяет PSR-2. Он описывает правила форматирования PHP-кода, чтобы обеспечить его единообразие и читаемость.

Основные правила PSR-12:

1. Общие положения:

• Код должен соответствовать PSR-1.

• Используйте 4 пробела для отступов, а не табуляцию.

• Строки должны быть не длиннее 120 символов.

• Не используйте принудительные переносы строк.

• Оставляйте пустую строку после блока declare(strict_types=1);.

• Оставляйте пустую строку после блока namespace.

• Оставляйте пустую строку между блоками use.

2. Объявление классов:

• Ключевое слово class должно быть на одной строке с именем класса.

• Открывающая фигурная скобка класса должна быть на новой строке.

• Закрывающая фигурная скобка класса должна быть на новой строке.

• Оставляйте пустую строку между методами класса.

Пример:

declare(strict_types=1);

namespace Vendor\Package;

use Vendor\Package\{ClassA as A, ClassB, ClassC as C};
use Vendor\Package\SomeNamespace\ClassD as D;

class MyClass
{
    public function myMethod()
    {
        // Код метода
    }

    public function anotherMethod()
    {
        // Код метода
    }
}

3. Объявление методов:

• Ключевое слово function должно быть на одной строке с именем метода.

• Открывающая фигурная скобка метода должна быть на новой строке.

• Закрывающая фигурная скобка метода должна быть на новой строке.

• Список аргументов должен быть разбит на несколько строк, если он слишком длинный.

Пример:

public function myMethod(
    int $arg1,
    string $arg2,
    array $arg3
) {
    // Код метода
}

4. Объявление свойств и констант:

• Свойства и константы должны быть объявлены в начале класса.

• Свойства должны быть объявлены с указанием видимости.

• Константы должны быть объявлены с ключевым словом const.

Пример:

class MyClass
{
    public const MY_CONSTANT = 'value';

    protected $myProperty;

    private $anotherProperty;
}

5. Управляющие структуры:

• Ключевое слово управляющей структуры должно быть на одной строке с открывающей круглой скобкой.

• Открывающая фигурная скобка должна быть на новой строке.

• Закрывающая фигурная скобка должна быть на новой строке.

• Список условий должен быть разбит на несколько строк, если он слишком длинный.

Пример:

if (
    $condition1
    && $condition2
    && $condition3
) {
    // Код
}

6. Выражения:

• Используйте пробелы вокруг операторов и после запятых.

• Не используйте пробелы вокруг скобок.

Пример:

$a = $b + $c;
$d = array(1, 2, 3);

7. Комментарии:

• Используйте комментарии в стиле PHPDoc для документирования кода.

• Комментарии должны быть оформлены в соответствии с PSR-5.

Пример:

/**
 * Этот метод выполняет действие.
 *
 * @param int $arg1 Первый аргумент.
 * @param string $arg2 Второй аргумент.
 * @return void
 */
public function myMethod(int $arg1, string $arg2)
{
    // Код метода
}

Заключение

PSR-12 - это важный стандарт, который помогает поддерживать чистоту и единообразие PHP-кода. Следуя ему, вы сделаете свой код более читаемым и понятным для других разработчиков.