Laravelで作ったものはEloquentモデルとEntityと分けて作成しています。

するとマッピングが面倒くさいです。JavaではModelMapperがあったのですが、PHPはあまり詳しくわからないので自分で作ってみました。

以下のマッピングが可能です

Eloquentモデル → 通常のクラス
通常のクラス → 通常のクラス

リフレクション

この手の作業にはリフレクションを利用することになると思います。リフレクションは非常に強力な機能ですし、Javaの現場では多用されていました。

Eloquentモデルから自作のEntityクラスへ変換できるのと、通常のクラスからクラスへと変換できる機能を作りました。

privateな変数でも値を書き換えるようにしています。

使い方

使い方はこんな感じです。変数名を揃えていないとマッピングがされません。

$product = Product::where('id',1)->first();
$mapper = new ModelMapper();
$entity = $mapper->eloquentMap(TestEntity::class, $product);

マッピングを除外したい変数がある場合は以下のようにexcluedを利用します。

$product = Product::where('id',1)->first();
$mapper = new ModelMapper();
$entity = $mapper->exclued("name","arrival_day")->eloquentMap(TestEntity::class, $product);

ソース

gistにソースはアップロードしています。

eloquentモデルのマッピングは以下のようになっています。変換元が eloquentモデルになりますので、$origin[‘name’]のようにしてattributeにアクセスできるので、そこはリフレクションを使わずに行います。

/**
     * EloquentModelをマッピングします。
     * @param $clazz ターゲットクラス
     * @param $origin 変換元オブジェクト
     * 
     */
    public function eloquentMap($clazz, $origin)
    {
        // 存在しないattributeはnull判定
        //dd($origin['naiume']);

        // ターゲットクラスの結果オブジェクト
        $result = new $clazz;
        // ターゲットクラスのリフレクション
        $targetRef = new ReflectionClass($clazz);

        foreach($targetRef->getProperties() as $prop)
        {
            $name = $prop->name;
            // 除外リストに入っている変数名はスキップする
            if($this->inExclude($name)){
                continue;
            }
            // nullが入って代入エラーにならないようにスキップさせる
            if($origin[$name] === null)
            {
                continue;
            }

            $prop->setAccessible(true);
            $prop->setValue($result, $origin[$name]);
        } 
        return $result;
    }

除外リストは以下のように制御します。除外変数名配列を用意しておいて、exclued関数ではその配列に引数で渡ってきた変数名を格納します。そして自分自身を返却することで、メソッドチェーンで利用できます。

// 除外リスト
    private array $exclusion = array();

    /**
     * 除外したい変数名を設定します
     * @param $args 除外変数名
     * @return ModelMapper モデルマッパークラス
     */
    public function exclued(string ...$args) : ModelMapper
    {
        foreach($args as $arg)
        {
            array_push($this->exclusion, $arg);
        }
        return $this;
    }

除外リストチェック

チェックはin_arrayを利用しているだけです。

/**
     * 除外変数リストに変数名が入っているかどうか調べます。
     * 入っている場合はtrue
     */
    private function inExclude(string $name) : bool
    {
        return in_array($name,$this->exclusion);
    }

通常のクラスと別のクラスにマッピングする例

通常のクラスと通常のクラスのマッピングはmapメソッドを利用します。

$model = new TestModel();
$model->name = "ZONe";
$model->price = 165;
$model->count = 20;

$mapper = new ModelMapper();
$entity = $mapper->map(TestEntity::class, $model);

ソースは以下のようになっています

/**
     * @param $clazz ターゲットクラス
     * @param $origin 変換元オブジェクト
     * 
     */
    public function map($clazz, $origin)
    {
        // ターゲットクラスの結果オブジェクト
        $result = new $clazz;
        // ターゲットクラスのリフレクション
        $targetRef = new ReflectionClass($clazz);
        // 変換元クラスのリフレクション
        $originRef = new ReflectionClass($origin::class);

        foreach($targetRef->getProperties() as $prop)
        {
            $name = $prop->name;
            if($this->inExclude($name)){
                continue;
            }
            // 変換元に同一の変数名が存在しない場合はスキップ
            if(!$originRef->hasProperty($name)){
                continue;
            }
            $val = $targetRef->getProperty($name);
            $val->setAccessible(true);
            $val->setValue($result, $origin->$name);
        } 
        return $result;
    }

マッピングに利用したクラスは以下のようになっています

class TestEntity 
{
    public string $name;

    private int $price;

    private int $count;

    public DateTime $arrival_day;

    public function execute()
    {
        echo("execute method.");
    }
}

class TestModel
{
    public string $name;

    public int $price;

    public int $count;

}

public function up()
    {
        Schema::create('products', function (Blueprint $table) {
            $table->id();
            $table->string('name');
            $table->integer('price');
            $table->date('arrival_day');
            $table->timestamps();
        });
    }

DBから取得する際に日付型にする

class Product extends Model
{
    use HasFactory;

    protected $dates = [
        'created_at',
        'updated_at',
        'arrival_day'
    ];
}

リフレクションの勉強記録

こんなクラスがあります

class TestEntity 
{
    public string $name;

    private int $price;

    public static int $count;
}

リフレクションで上記のクラスを見ていきます。

getProperties

引数の$clazzはTestEntity::classです。

プロパティの配列を取得します。

$ref = new ReflectionClass($clazz);
var_dump($ref->getProperties());

array(3) { [0]=&gt; object(ReflectionProperty)#304 (2) { [&quot;name&quot;]=&gt; string(4) &quot;name&quot; [&quot;class&quot;]=&gt; string(28) &quot;App\Domain\Entity\TestEntity&quot; } [1]=&gt; object(ReflectionProperty)#305 (2) { [&quot;name&quot;]=&gt; string(5) &quot;price&quot; [&quot;class&quot;]=&gt; string(28) &quot;App\Domain\Entity\TestEntity&quot; } [2]=&gt; object(ReflectionProperty)#306 (2) { [&quot;name&quot;]=&gt; string(5) &quot;count&quot; [&quot;class&quot;]=&gt; string(28) &quot;App\Domain\Entity\TestEntity&quot; } }

publicに限定する

$ref = new ReflectionClass($clazz);
var_dump($ref->getProperties(ReflectionProperty::IS_PUBLIC));

array(2) { [0]=&gt; object(ReflectionProperty)#304 (2) { [&quot;name&quot;]=&gt; string(4) &quot;name&quot; [&quot;class&quot;]=&gt; string(28) &quot;App\Domain\Entity\TestEntity&quot; } [1]=&gt; object(ReflectionProperty)#305 (2) { [&quot;name&quot;]=&gt; string(5) &quot;count&quot; [&quot;class&quot;]=&gt; string(28) &quot;App\Domain\Entity\TestEntity&quot; } }

変数名を取得する

変数名だけを取得するにはループしてnameを取得すればよいです

$ref = new ReflectionClass($clazz);
foreach($ref->getProperties() as $prop)
{
   echo $prop->name . " ";
}

変数にセットする

private変数にはアクセスができないですが、setAccessibleメソッドを利用すると強制的にアクセスできるようになります。

// 値をセットするクラスのインスタンス
$result = new $clazz;
// 値をセットするクラスのリフレクションクラス
$ref = new ReflectionClass($clazz);  
foreach($ref->getProperties() as $prop)
{
    // privateな変数はsetValueできないのでpublicとして扱う
    // Cannot access non-public property App\Domain\Entity\TestEntity::$price
    $prop->setAccessible(true);
    $prop->setValue($result, 10);
} 
dd($result);

getMethods

クラスのメソッドを配列で取得します

メソッドを追加しておきます

class TestEntity 
{
    public string $name;

    private int $price;

    public static int $count;

    public function execute()
    {
        echo("execute method.");
    }
}

$ref = new ReflectionClass($clazz);
var_dump($ref->getMethods());

array(1) { [0]=&gt; object(ReflectionMethod)#304 (2) { [&quot;name&quot;]=&gt; string(7) &quot;execute&quot; [&quot;class&quot;]=&gt; string(28) &quot;App\Domain\Entity\TestEntity&quot; } }

関数名を取得する

配列をループしてnameを取得すれば関数名を取得できます。

$ref = new ReflectionClass($clazz);  
foreach($ref->getMethods() as $method)
{
   echo $method->name . " ";
}

invoke

関数を起動します。参考

まずReflectionMethodクラスのインスタンスを取得して、invokeメソッドの引数には対象のクラスのインスタンスを指定します。

$ref = new ReflectionClass($clazz);  
foreach($ref->getMethods() as $method)
{
    // クラス関数でない関数にはReflectionFunctionが用意されています
    $method = new ReflectionMethod($clazz,$method->name);
    $method->invoke(new $clazz);
}

Laravelのモデルマッパーを自作した