マジックメソッド on ララジャパン

混乱してはいけないLaravelの動的プロパティ - PHP8.2で廃止となった編

Mon, 20 May 2024 08:31:31 +0900

さあ大変です。PHP 8.2において動的プロパティが廃止(Deprecated）となりました。PHP 9.0ではErrorExceptionが投げられるようです。動的プロパティをたくさん使っているLaravelのプログラムは大丈夫なのでしょうか？

動的プロパティが廃止とはどういうこと？

空のクラスを作成します。

app/Models/Person.php

namespace App\Models;

class Person
{
    //
}

PHP 8.1では、好き勝手に動的プロパティを作成できます。

> use App\Models\Person;
> $person = new Person;
= App\Models\Person {#5068}

> $person->first_name = 'Joe';
= "Joe"

> $person->first_name;
= "Joe"

しかし、同様なコードの実行をPHP 8.2下で行うと、

> use App\Models\Person;
> $person = new Person;
= App\Models\Person {#5068}

> $person->first_name = 'Joe';

   DEPRECATED  Creation of dynamic property App\Models\Person::$first_name is deprecated.

= "Joe"

と、しっかり廃止のエラーが表示されます。Deprecated（廃止）なのでDisabled（無効）になったわけではなくエラーとはならずに警告のみです。つまり、実行はされているので値はGETできます。

> $person->first_name;
= "Joe"

もちろん、動的プロパティでなくプロパティがクラスで予め宣言されているなら問題ありません。

app/Models/Person.php

namespace App\Models;

// 以下はModelを継承していないことに注意
class Person
{
    public string $first_name;
}

と定義したなら、以下のようにfirst_nameをセットしても、警告なしです。

> use App\Models\Person;
> $person = new Person;
= App\Models\Person {#5068
    +first_name: ? string,
  }

> $person->first_name = 'Joe';
= "Joe"

PHP 8.2以降で動的プロパティに対応するには、どうしたらよいのでしょう？

マジックメソッドを使う

前回説明したマジックメソッドを使用するなら問題ありません。

app/Models/Person.php

namespace App\Models;

// 以下はModelを継承していないことに注意
class Person
{
    protected array $attributes = [];

    //　プロパティの値を取得
    public function __get(string $key ) : ?mixed
    {
        if (isset($this->attributes[$key])) {
            return $this->attributes[$key];
        }

        return null;
    }

    //　プロパティを設定
    public function __set(string $key, mixed $value)
    {
        $this->attributes[$key] = $value;
    }
}

ということは、LaravelのEloquentやCollectionを使用したコードを書き換える必要はなしです。良かったです。安堵！

stdClassを使う

stdClassを使っても動的プロパティの作成が警告なしに可能となります。

> $person = new StdClass;
= {#5072}

> $person->first_name = 'Joe';
= "Joe"

さらに、stdClassを継承してクラスを作成してもOKです。

app/Models/Person.php

namespace App\Models;

use stdClass;

class Person extends stdClass;
{
    //
}

Attributeを使う

PHP8.0 から導入されたAttributeを使用しても動的プロパティの作成が可能です。

つまり、

app/Models/Person.php

namespace App\Models;

// 以下は、動的プロパティ許可としています
#[\AllowDynamicProperties]
class Person
{
    //
}

参照

混乱してはいけないLaravelの動的プロパティ – Eloquent編混乱してはいけないLaravelの動的プロパティ – Collection編混乱してはいけないLaravelの動的プロパティ – 裏側編

混乱してはいけないLaravelの動的プロパティ - 裏側編

Wed, 15 May 2024 23:27:32 +0900

今回は、Laravelの動的プロパティの裏側を見てみます。つまり、どうしてインスタンスのプロパティがメソッドのコールとなるのか。

マジックメソッド

知って入ればなんのことはないですが、phpではマジックメソッドという関数をクラスで定義すれば、クラスで定義されているメソッドを、インスタンスのプロパティとしてアクセスすることができます。

簡単にマジックメソッドの説明をしましょう。

まずは、Personというクラスを作成します。Modelsのネームスペースに入れてありますが、デモのためにEloquentのModelクラスは継承しません。

app/Models/Person.php

namespace App\Models;

// 以下はModelを継承していないことに注意
class Person
{
    protected array $attributes = [];

    //　プロパティの値を取得
    public function __get(string $key ) : ?mixed
    {
        if (isset($this->attributes[$key])) {
            return $this->attributes[$key];
        }

        return null;
    }

    //　プロパティを設定
    public function __set(string $key, mixed $value)
    {
        $this->attributes[$key] = $value;
    }

    //　すべてのプロパティをリスト
    public function getAttributes(): array
    {
        return $this->attributes;
    }
}

２つの_（アンダースコア）で始まるメソッド名、__get()と__set()がマジックメソッドです。

tinkerで実行すると、以下のようにインスタンスに好きなプロパティ名で値を与えることができます。

> use App\Models\Person;
> $person = new Person;
= App\Models\Person {#5077}

> $person->first_name = 'Joe';
= "Joe"

> $person->last_name = 'Biden';
= "Biden"

裏では、上のクラスの定義の__set()、つまりミューテーターが実行されています。その証拠に、$attributeの中身を見ると、

> $person->getAttributes();
= [
    "first_name" => "Joe",
    "last_name" => "Biden",
  ]

と連想配列に値が入っています。

また、__get()の定義のために、

> $person->first_name;
= "Joe"

> $person->last_name;
= "Biden"

とそれぞれのプロパティの値を取り出すことが可能です。

しかし、$attributesにキーがないプロパティにアクセスすると、

> $person->full_name;
= null

とnullを返します。

プロパティがなかったらメソッドコール

さて、今度はプロパティが存在しないときにメソッドをコールしてみましょう。プロパティがfull_nameならfullName()をコールするように対応してみました。

namespace App\Models;

use Illuminate\Support\Str;

class Person
{
    protected array $attributes = [];

    public function __get(string $key ) : mixed
    {
        if (isset($this->attributes[$key])) {
            return $this->attributes[$key];
        }

        // full_nameがキーなら、fullName()をコール
        if (method_exists($this, Str::camel($key))) {
            return $this->{Str::camel($key)}();
        }

        return null;
    }
    
    ...

    // 新規に定義
    protected function fullName()
    {
        return $this->attributes['first_name'].' '.$this->attributes['last_name'];
    }
}

実行すると、full_nameの動的プロパティの値が返ります。

> $person->full_name;
= "Joe Biden"

もちろん、LaravelのModelのクラスではいろいろなケースがあるので、その動的プロパティのメカニズムはこれよりはるかに複雑ですが、マジックメソッドを使用して対応するのは同じです。

Laravelでのマジックメソッド

さて、Laravelで本当にマジックメソッドが使用されているか確認してみましょう。

まずは、EloquentのModelクラスでは、以下のように、マジックメソッドが定義されています。

vendor/laravel/framework/src/Illuminate/Database/Eloquent/Model.php

namespace Illuminate\Database\Eloquent;

...
abstract class Model implements Arrayable, ArrayAccess, CanBeEscapedWhenCastToString, HasBroadcastChannel, Jsonable, JsonSerializable, QueueableEntity, Stringable, UrlRoutable
{
...
   /**
     * Dynamically retrieve attributes on the model.
     *
     * @param  string  $key
     * @return mixed
     */
    public function __get($key)
    {
        return $this->getAttribute($key);
    }

    /**
     * Dynamically set attributes on the model.
     *
     * @param  string  $key
     * @param  mixed  $value
     * @return void
     */
    public function __set($key, $value)
    {
        $this->setAttribute($key, $value);
    }
...

このコードレベルではすっきりしていますが、興味ある方は奥までコードを辿ってみてください。いろいろなケースの対応がされています。

そして、Collectionでは、HigherOrderCollectionProxyのクラスの中で、マジックメソッドが定義されています。

vendor/laravel/framework/src/Illuminate/Collections/HigherOrderCollectionProxy.php

namespace Illuminate\Support;

/**
 * @mixin \Illuminate\Support\Enumerable
 */
class HigherOrderCollectionProxy
{
...
    /**
     * Proxy accessing an attribute onto the collection items.
     *
     * @param  string  $key
     * @return mixed
     */
    public function __get($key)
    {
        return $this->collection->{$this->method}(function ($value) use ($key) {
            return is_array($value) ? $value[$key] : $value->{$key};
        });
    }

    /**
     * Proxy a method call onto the collection items.
     *
     * @param  string  $method
     * @param  array  $parameters
     * @return mixed
     */
    public function __call($method, $parameters)
    {
        return $this->collection->{$this->method}(function ($value) use ($method, $parameters) {
            return $value->{$method}(...$parameters);
        });
    }
}

他のどのクラスでマジックメソッドが使用されているか、vendor/laravel/のディレクトリで、grepしてみました。いろいろありますね。

framework/src/Illuminate/Routing/Route.php
framework/src/Illuminate/View/InvokableComponentVariable.php
framework/src/Illuminate/Database/Eloquent/Model.php
framework/src/Illuminate/Database/Eloquent/Builder.php
framework/src/Illuminate/Bus/Batch.php
framework/src/Illuminate/Conditionable/HigherOrderWhenProxy.php
framework/src/Illuminate/Auth/GenericUser.php
framework/src/Illuminate/Mail/Events/MessageSent.php
framework/src/Illuminate/Queue/Jobs/DatabaseJobRecord.php
framework/src/Illuminate/Support/ViewErrorBag.php
framework/src/Illuminate/Support/ValidatedInput.php
framework/src/Illuminate/Support/Optional.php
framework/src/Illuminate/Support/Fluent.php
framework/src/Illuminate/Support/Stringable.php
framework/src/Illuminate/Http/Request.php
framework/src/Illuminate/Http/Resources/DelegatesToResource.php
framework/src/Illuminate/Testing/TestResponse.php
framework/src/Illuminate/Testing/TestComponent.php
framework/src/Illuminate/Container/Container.php
framework/src/Illuminate/Collections/HigherOrderCollectionProxy.php
framework/src/Illuminate/Collections/Enumerable.php
framework/src/Illuminate/Collections/Traits/EnumeratesValues.php

参照

混乱してはいけないLaravelの動的プロパティ – Eloquent編混乱してはいけないLaravelの動的プロパティ – Collection編混乱してはいけないLaravelの動的プロパティ – PHP8.2で廃止となった編