php8.0 のキャッチアップ - コンストラクタにおける簡略記法

Sun, 23 Apr 2023 00:36:42 +0900

前回のmatch式の紹介に続き、PHP8.0で導入されたsyntaxの紹介です。今回は Constructor Property Promotion について。

Constructor Property Promotion

Classにおいてコンストラクタの引数に指定した値をそのままプロパティに割り当てる事がよくあります。例えば、以下のように。

class Person
{
    public string $name;
    public int $age;
    public string $sex;

    public function __construct(string $name, int $age, string $sex)
    {
        $this->name = $name;
        $this->age = $age;
        $this->sex = $sex;
    }
}

上記ではインスタンスプロパティを宣言し、コンストラクタ内の処理で値をセットしています。引数に指定した変数を何度も書かなければならないので冗長ですね。

PHP8.0からは次のように、引数にアクセス修飾子(public, protected, private)を付与することでプロパティの宣言と値のセットを同時に行うことができます。

class Person
{
    public function __construct(
        public string $name,
        public int $age,
        public string $sex
    ) {}

簡潔になりスッキリしました。

プロパティへの値の割当はコンストラクタの処理が走る前に行われるので、コンストラクタ内で参照する事もできます。

class Person
{
    public $initial;

    public function __construct(public string $name)
    {
        // イニシャルを取得
        $this->initial = strtoupper(substr($this->name, 0, 1));
    }
}

// インスタンス生成時にイニシャルが割り当てられている
$person = new Person('Steve');
echo $person->initial;

>>> 'S'

導入する事でシンプルに行数が減るので良いのですが、既存のプロジェクトのクラスを全て書き換えるのは骨が折れそうです。

何か一括で書き換える方法は無いものかと調べた処、 Rectorというツールでできることが分かりました。次回の記事でその手順を紹介させていただきます。

php8.0 のキャッチアップ - match式

Fri, 24 Feb 2023 07:02:58 +0900

巷ではLaravel 10がリリースされ賑わっていますが、最近私が担当した案件はL9へのUpgradeです。いつもの様にLaravel Shiftが出してくれるPull Requestを眺めていると、見慣れない記法が出てきました。調べてみるとPHP8.0から導入されてた記法でした。

PHP8.0がリリースされて間も無くキャッチアップしたはずなのですが、全く記憶にありません。ということで、再度PHP8.0から導入された機能を復習しました。いくつか取り入れたい記法を見つけたのでご紹介します。今回はmatch式です。

match式

公式マニュアルより抜粋。

$return_value = match (制約式) {
    単一の条件式 => 返却式,
    条件式1, 条件式2 => 返却式,
};

match式はswitch文と似ています。条件とそれにmatchした場合に返却する値を指定します。

switch文と異なり条件にmatchしているか比較する際に"=="ではなく"==="が用いられます。

つまり、

// switch文
$num = '0';

switch ($num) {
    case 0:
        echo "integer zero";
        break;
    case '0':
        echo "string zero";
}

>> integer zero

// match式
$matched = match ($num) {
    0 => "integer zero",
    '0' => "string zero",
};

echo $matched;

>> string zero

因みにmatchは式なので末尾のセミコロンを忘れないように注意です！

複数の条件で同じ値を返す場合やいずれの条件にも当てはまらなかった場合（デフォルト）の書き方はswitch文と似ているので理解しやすいです。

$matched = match ($trafficSignal) {
    'blue', 'green' => 'go',    // blue, green のいずれかなら
    'yellow' => 'caution',
    'red' => 'stop',
    default => 'nothing to do'    // いずれの条件にもmatchしないなら
};

Laravel9から学ぶ活用方法

Laravel9からはPHP8.0以上が要件となった事で、ソースコード内でも色々な箇所で活用されている様です。どの様な使い方をしているのでしょうか？

例えば、Handler.php にて例外がスローされた際のレスポンスをレンダリングしている箇所では

vendor/laravel/framework/src/Illuminate/Foundation/Exceptions/Handler.php

    public function render($request, Throwable $e)
    {
        〜〜省略〜〜

        return match (true) {
            $e instanceof HttpResponseException => $e->getResponse(),
            $e instanceof AuthenticationException => $this->unauthenticated($request, $e),
            $e instanceof ValidationException => $this->convertValidationExceptionToResponse($e, $request),
            default => $this->renderExceptionResponse($request, $e),
        };
    }

前の段落で扱ったサンプルコードではいずれも制約式に変数を渡していましたが、こちらはtrueを指定しています。そして、上から順番にtrueを返す条件式が無いかチェックしていきます。

もし、$eがHttpResponseExceptionのインスタンスなら、$e->getResponse()を実行して結果を返却。それ以外でもし、$eがAuthenticationExceptionのインスタンスなら、$this->unauthenticated($request, $e)を実行して結果を返却。それ以外でもし、、、（以下省略）

これはつまり、従来は if … elseif … で書いていたパターンですね。

実際、Laravel 8まではif文で書かれていた様です。