PHP の移行後のコードの品質

型を付ける前と後

<?php
// 移行の直後: 型がなく、配列の中身も分からない
function subtotal($items)
{
    $sum = 0;
    foreach ($items as $item) {
        $sum += $item['price'] * $item['qty'];
    }
    return $sum;
}

<?php
declare(strict_types=1);

// 税率を enum で表し、取り得る値を限る(8.1 から)
enum TaxRate: string
{
    case Standard = 'standard';
    case Reduced = 'reduced';

    public function rate(): float
    {
        return match ($this) {
            self::Standard => 0.10,
            self::Reduced => 0.08,
        };
    }
}

// 明細を、変更できないクラスで表す(readonly クラスは 8.2 から)
final readonly class LineItem
{
    public function __construct(
        public int $price,
        public int $quantity,
        public TaxRate $taxRate,
    ) {}
}

/** @param list<LineItem> $items */
function subtotal(array $items): int
{
    $sum = 0;
    foreach ($items as $item) {
        $sum += $item->price * $item->quantity;
    }
    return $sum;
}

strict_types

• ファイルの最初に declare(strict_types=1); を書くと、そのファイルからの関数の呼び出しで、型の自動の変換が止まり、合わないと TypeError になります
• 戻り値は、関数を定義したファイルの決まりで検査されます。対象は int、float、string、bool のスカラーの型だけで、int は float の型を通ります

バージョンごとに使えるようになった型

PHPStan の設定 (phpstan.neon)

# 今ある指摘は phpstan-baseline.neon に記録する(--generate-baseline)
includes:
    - phpstan-baseline.neon
parameters:
    level: 6
    paths:
        - src
        - tests

PHPStan 2.3 のレベルは 0 から 10 です。レベル 10 (PHPStan 2.0 から) は、型が書かれていない値も報告します。phpstan-strict-rules で == や empty() の禁止などを、phpstan-deprecation-rules で @deprecated の使用の検出を足せます。

非推奨をテストで失敗にする (phpunit.xml)

<phpunit displayDetailsOnTestsThatTriggerDeprecations="true"
         failOnDeprecation="true">
    <source>
        <include>
            <directory>src</directory>
        </include>
    </source>
</phpunit>

PHPUnit 13 は PHP 8.4 以上、12 は PHP 8.3 以上が必要です。<source> で自分のコードを指定すると、依存パッケージが出した非推奨と分けて扱えます。

CI の例 (GitHub Actions)

strategy:
  matrix:
    php: ['8.4', '8.5']
steps:
  - uses: shivammathur/setup-php@v2
    with:
      php-version: ${{ matrix.php }}
  - run: composer install
  - run: composer audit
  - run: vendor/bin/php-cs-fixer fix --dry-run --diff
  - run: vendor/bin/phpstan analyse
  - run: vendor/bin/rector --dry-run
  - run: vendor/bin/phpunit