【Laravel】Eloquent Tips

PHP Laravel

Eloquentを使う際にちょっと便利になるTipsをまとめてみました。
網羅性はないので参考程度に。

テーブル名の変更

$tableを定義することで任意のテーブルへのアクセス出来ます。

<?php

use Illuminate\Database\Eloquent\Model;

class Example extends Model
{
    protected $table = 'custom_example';
}

主キー名の変更

$primaryKeyを定義して変更することが可能です。

<?php

use Illuminate\Database\Eloquent\Model;

class Example extends Model
{
    // デフォルトは'id'で定義されています。
    protected $primaryKey = 'custom_key';
}

主キーの型を変更する

$keyTypeを定義して変更することが可能です。

<?php

use Illuminate\Database\Eloquent\Model;

class Example extends Model
{
    // デフォルトは'int'で定義されています。
    protected $keyType = 'string';
}

主キーのインクリメントをしないようにする

$incrementingを定義して変更することが可能です。

<?php

use Illuminate\Database\Eloquent\Model;

class Example extends Model
{
    // デフォルトはtrueで定義されています。
    protected $incrementing = false;
}

デフォルトのタイムスタンプを使用しないようにする

$timestampsを定義することでデフォルトのタイムスタンプを使用しなくなります。

<?php

use Illuminate\Database\Eloquent\Model;

class Example extends Model
{
    // デフォルトはtrueで定義されています。
    public $timestamps = false;
}

詳細はIlluminate\Database\Eloquent\Concerns\HasTimestampsを参照してください。

タイムスタンプのカラム名を変更する

モデルクラスにCREATED_AT、UPDATED_ATを定義することで変更できます。

<?php

use Illuminate\Database\Eloquent\Model;

class Example extends Model
{
    const CREATED_AT = 'created';
    const UPDATED_AT = 'updated';
}

タイムスタンプのプロパティからCarbonのメソッドを実行

次のようなマイグレーションを作成します。

<?php

use Illuminate\Support\Facades\Schema;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Migrations\Migration;

class CreateSampleTable extends Migration
{
    public function up()
    {
        Schema::create('sample', function (Blueprint $table) {
            $table->bigIncrements('id');
            $table->string('text');
            // created_at, updated_atカラムが追加されます。
            $table->timestamps();
        });
    }

    public function down()
    {
        Schema::dropIfExists('sample');
    }
}

モデルクラスをSampleとした時、次のような実行が可能です。

<?php

namespace App\Http\Controllers;

use App\Sample;

class HomeController extends Controller
{
    public function index()
    {
        /** @var App\Sample $sample */
        $sample = Sample::find(1);

        // 時刻の差分を取得
        $diff = $sample->created_at->diffForHumans();
    }
}

created_at、updated_atにアクセスすると、Carbonオブジェクトに変換してくれています。
そのため、diffForHumansなどのメソッドが呼び出せます。

詳細はIlluminate\Database\Eloquent\Concerns\HasAttributesを参照してください。

また、独自にCarbonオブジェクトで受け取りたいカラムを設定したい場合は$datesを定義することで可能です。

<?php

use Illuminate\Database\Eloquent\Model;

class Example extends Model
{
    // created_at, updated_at以外のカラム名を追加します。
    protected $dates = [
        'created', 'updated'
    ];
}