Проверка PHP кода: инструменты и подходы

Расширенные примеры проверки PHP кода

Ниже приведены более глубокие и нестандартные сценарии применения инструментов проверки.

Настройка PHPStan с кастомными правилами и уровнями

Конфигурация phpstan.neon позволяет тонко управлять проверками:

parameters:
    level: 9
    paths:
        - src
    excludePaths:
        - src/Legacy/*
    checkMissingIterableValueType: true
    reportMaybes: false
    treatPhpDocTypesAsCertain: false
    customRulesetUsed: true
    rules:
        - vendor/some/package/custom-rules/Rule.php

Затем запуск:

php vendor/bin/phpstan analyse --configuration phpstan.neon

Результат может содержать только ошибки, относящиеся к строгим типам и отсутствующим аннотациям:

 ------ ---------------------------------------------------------------- 
  Line   src/Service/Validator.php
 ------ ---------------------------------------------------------------- 
  15     Parameter $value of method Validator::validate() has no type specified.
 ------ ---------------------------------------------------------------- 

Использование PHP_CodeSniffer с автоматическим исправлением

Инструмент phpcbf автоматически исправляет многие нарушения стиля:

vendor/bin/phpcbf --standard=PSR12 src/ --no-patch

Пример до и после:

// До: неправильный отступ и скобки
class MyClass{
  public function test(){
    echo 'hi';
  }
}

// После phpcbf:
class MyClass
{
    public function test()
    {
        echo 'hi';
    }
}

Интеграция Psalm с GitHub Actions

Для постоянной проверки кода в CI используют Psalm. Пример workflow:

name: Psalm
on: [push]
jobs:
  psalm:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: shivammathur/setup-php@v2
        with:
          php-version: '8.2'
          tools: vimeo/psalm
      - run: psalm --show-info=true --output-format=github

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

Глубокое профилирование с Xdebug и Blackfire

Кроме KCachegrind, можно использовать Blackfire для профилирования в продакшене. Пример настройки:

# Установка Blackfire PHP extension
composer require blackfire/php-sdk

# Профилирование участка кода
$probe = new \Blackfire\Probe();
$probe->enable();
// код для профилирования
$probe->disable();
$output = $probe->getData();

Это даёт детальную информацию о времени выполнения и памяти для конкретного участка.

Нестандартный пример: проверка конфигурационных файлов на соответствие схеме

Для проектов, где PHP код читает YAML/JSON конфиги, можно использовать библиотеку justinrainbow/json-schema для валидации структуры:

use JsonSchema\Validator;

$schema = json_decode(file_get_contents('schema.json'));
$data = json_decode(file_get_contents('config.json'));

$validator = new Validator();
$validator->validate($data, $schema);

if (!$validator->isValid()) {
    foreach ($validator->getErrors() as $error) {
        echo sprintf("[%s] %s\n", $error['property'], $error['message']);
    }
}

Результат:

[database.host] The property host is required
[database.port] Integer value found, but a string is required