動的プロパティ 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で廃止となった編

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

Tue, 07 May 2024 22:49:37 +0900

動的プロパティは、EloquentだけでなくCollectionにもHigher Order Message（より上級のメッセージ？）という名前で颯爽と登場します。これも最初に見たら、こんなことできるの、という感じです。混乱してはいけません。Eloquentと同様に複雑なことをしないときのコード表現に便利なメソッドの短縮形です。

以下の前回の話も参照してください。混乱してはいけないLaravelの動的プロパティ - Eloquent編

Collectionメソッドを動的プロパティとして扱う

Laravelのマニュアルと似たような例を使います。

ここでは、スポーツ選手のプレイヤーをクラス（Player）とします。クラスにはプロパティとして、名前、人気の投票数、そしてVIPかどうかの３つの項目があります。例としてtinkerで表示されるようにプロパティは皆publicとしています。さらに、投票数が500以上ならVIPを正とする関数も定義されています。

app/Models/Player.php

namespace App\Models;

Class Player
{
    function __construct(
        public string $name,　// 名前
        public int $votes,  // 投票数
        public bool $isVip = false)　// VIP？
    {
        //
    }

    public function markAsVip(): void
    {
        if ($this->votes >= 500) { // 500数以上ならVIPに設定
            $this->isVip = true;
        }
    }
}

まず、２つインスタンスを含むCollectionを作成します。

> use App\Models\Player;

> $players = collect([
    new Player("LeBron James", 500), 
    new Player("Stephen Curry", 400)
]);

= Illuminate\Support\Collection {#5066
    all: [
      App\Models\Player {#5096
        +name: "LeBron James",
        +votes: 500,
        +isVip: false,
      },
      App\Models\Player {#5067
        +name: "Stephen Curry",
        +votes: 400,
        +isVip: false,
      },
    ],
  }

Collectionに含まれるプレイヤーのインスタンスにおいて、人気票に基づいてVIPかどうかを決めるとします。

通常なら、以下のようにCollectionのeach()のメソッドを使い、それぞれのインスタンスにおいてmarkAsVip()をコールバックします。

> $players->each(fn (Player $player) => $player->markAsVip());

= Illuminate\Support\Collection {#5101
    all: [
      App\Models\Player {#5089
        +name: "LeBron James",
        +votes: 500,
        +isVip: true,
      },
      App\Models\Player {#5102
        +name: "Stephen Curry",
        +votes: 400,
        +isVip: false,
      },
    ],
  }

しかし、なんとこれと同じことが、Collectionの動的プロパティとして以下のように短縮して実行も可能なのです。

> $players->each->markAsVip();

= Illuminate\Support\Collection {#5101
    all: [
      App\Models\Player {#5089
        +name: "LeBron James",
        +votes: 500,
        +isVip: true,
      },
      App\Models\Player {#5102
        +name: "Stephen Curry",
        +votes: 400,
        +isVip: false,
      },
    ],
  }

凄いですね。

Collectionの他のメソッドも使えます。VIPだけのプレイヤーを抽出したいとすると、filter()を動的プロパティとします。、

> $players->filter->isVip;
= Illuminate\Support\Collection {#5102
    all: [
      App\Models\Player {#5089
        +name: "LeBron James",
        +votes: 500,
        +isVip: true,
      },
    ],
  }

もう１つ例を見てみましょう。今度は、sum()を使ってプレーヤーの総投票数の計算もできてしまいます。

> $players->sum->votes;
= 900

ちなみに、このような短縮形が使えるのは、Collectionのすべてのメソッドとはいきませんが、以下のメソッドの使用が現在可能です。

average, avg, contains, each, every, filter, first, flatMap, groupBy, keyBy, map, max, min, partition, reject, skipUntil, skipWhile, some, sortBy, sortByDesc, sum, takeUntil, takeWhile, unique

参照

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

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

Fri, 19 Apr 2024 05:45:38 +0900

LaravelではModelやCollectionやRequestなどのクラスにおいて動的プロパティがコードの短縮形としてよく使われます。しかし、同じクラスでメソッドとして定義したものがいきなりプロパティとして使われるので、私は昔よく混乱したものです。今回はまずEloquent編として代表的な動的プロパティの活用を混乱しないように説明します。

Eloquentのアクセッサー

まず、動的プロパティの例として、DBには対応する項目は存在しないのに、あたかも存在する項目のように振る舞うEloquentのアクセッサーです（ミューテーターも同じですが）。

DBのテーブルにfirst_name（名前）とlast_name（苗字）が存在するとして、姓名（full_name）を返すアクセッサーメソッドを定義します。

namespace App\Models;
 
use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Model;
 
class User extends Model
{
...
    /**
     * 姓名を返すアクセッサー
     *
     * @return \Illuminate\Database\Eloquent\Casts\Attribute
     */
    protected function fullName(): Attribute
    {
        return Attribute::make(
            get: fn ($value, $attribute) => $attribute['last_name'].' '.$attribute['first_name'],
        );
    }
}

これを使用するときは、動的プロパティとして以下のように使います。

> User::find(1);
[!] Aliasing 'User' to 'App\Models\User' for this Tinker session.
= App\Models\User {#5393
    id: 1,
    created_at: "2024-04-16 03:42:31",
    updated_at: "2024-04-16 03:42:31",
    first_name: "直子",
    last_name: "山田",
  }

> User::find(1)->full_name;
= "山田 直子"

先ほどのアクセッサーのメソッドfullName()をコールして姓名full_nameを動的プロパティとして返します。

ちなみに、fullName()のメソッドはprotectedで宣言されているので直接はコールできません。

> User::find(1)->fullName();
   BadMethodCallException  Call to undefined method App\Models\User::fullName().

EloquentのRelationship

今度は、EloquentのRelationshipの動的プロパティです

典型的なブログを例として、ユーザーとブログの投稿を使います。それぞれのDBテーブルを代表してUserとPostがModelのクラスとなります。そして、Userのクラスでは、それらの１対多の関係を以下のように定義します。

namespace App\Models;
 
use Illuminate\Database\Eloquent\Model;
 
class User extends Model
{
    /**
     * ユーザー１に対して複数のブログの投稿
     */
    public function posts()
    {
        return $this->hasMany(Post::class);
    }
}

この関係を利用して、特定のユーザーのブログのレコードを取得するのは通常以下のようになります。

$user = User::find(1);
$posts = $user->posts()->get(); // Collectionを返す

しかし、動的プロパティを使うと、

$posts = $user->posts;

と短縮形で書くことができます。先の非短縮形と同じ結果となります。便利ですね。

しかし、この短縮形、非短縮形でできることがなんでもできる訳ではありません

例えば、非短縮形のメソッド方式では、

$user->posts()->orderBy('created_at')->get();

とレコードをソートできますが、短縮形の動的プロパティの使用ではエラーとなります。

$user->posts->orderBy('created_at');

BadMethodCallException  Method Illuminate\Database\Eloquent\Collection::orderBy does not exist.

これは、$user->posts()がIlluminate\Database\Eloquent\Relations\HasManyを返すのに、$user->postではIlluminate\Database\Eloquent\Collectionを返すからです。Collectionには、orderBy()というメソッドはないのです。しかし、前者にはあります。

ちなみに後者では、CollectionのメソッドsortBy()を使用すると同じ結果が得られます。

$user->posts->sortBy('created_at');

もう１つ、より混乱しそうな例を挙げてみましょう。

まずは非短縮形から、

$user->posts()->where('title', '=', 'ブログタイトル')->get();

タイトルに特定の条件で絞ったクエリーです。ちなみに、実行されたSQLは、以下となります。

select * from `post` where `user`.`id` = 1 and `user`.`id` is not null and `title` = 'ブログタイトル';

さて、これを短縮形の動的プロパティで書くと、

$user->posts->where('title', '=', 'ブログタイトル');

->get()がないだけの違いですが、これはまったく正規です。返す結果も前者と同じです。where()はCollectionのメソッドにもあるのですね。

実行されたSQLも見てみましょう。

select * from `post` where `user`.`id` = 1 and `user`.`id` is not null;

違いわかりますか？タイトルを制限するwhereの条件文がSQL文にありません。つまり、ユーザーが投稿したレコードをいったん全部取得して、Collectionのwhere()のメソッドでフィルターしているのです。

両者ともに実行結果は同じですが、どこまでがデータベースにより実行されるか、どこからがCollectionのメソッドで実行するかにおいての違いです。この違いでパフォーマンスが違ってきます。一般的には前者のようにDBにたくさん仕事をしてもらうのが効率的です。注意が必要ですね。

参照

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