イントロダクション
Eloquent ORMはLaravelに含まれている、美しくシンプルなアクティブレコードによるデーター操作の実装です。それぞれのデータベーステーブルは関連する「モデル」と結びついています。モデルによりテーブル中のデータをクエリできますし、さらに新しいレコードを追加することもできます。
使いはじめる前に確実にcofig/database.php
を設定してください。データベースの詳細はドキュメントで確認してください。
モデル定義
利用を開始するには、まずEloquentモデルを作成しましょう。通常モデルはapp
ディレクトリ下に置きますが、composer.json
ファイルでオートロードするように指定した場所であれば、どこでも自由に設置できます。全てのEloquentモデルは、Illuminate\Database\Eloquent\Model
を拡張する必要があります。
モデルを作成する一番簡単な方法はmake:model
Artisanコマンドを使用することです。
php artisan make:model User
モデル作成時にデータベースマイグレーションも生成したければ、--migration
か-m
オプションを使ってください。
php artisan make:model User --migration
php artisan make:model User -m
Eloquentモデル規約
ではflights
データベーステーブルに情報を保存し、取得するために使用するFlight
モデルクラスを例として見てください。
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Flight extends Model
{
//
}
テーブル名
Flight
モデルにどのテーブルを使用するかEloquentに指定していない点に注目してください。他の名前を明示的に指定しない限り、クラス名を複数形の「スネークケース」にしたものがテーブル名として使用されます。今回の例でEloquentはFlight
モデルをflights
テーブルに保存します。モデルのtable
プロパティを定義し、カスタムテーブル名を指定できます。
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Flight extends Model
{
/**
* モデルと関連しているテーブル
*
* @var string
*/
protected $table = 'my_flights';
}
主キー
Eloquentは更にテーブルの主キーがid
というカラム名であると想定しています。この規約をオーバーライドする場合はprimaryKey
プロパティを定義してください。
さらに、Eloquentは主キーを自動増分される整数値であるとも想定しています。つまり、デフォルト状態で主キーは自動的にint
へキャストされます。自動増分ではない、もしくは整数値ではない主キーを使う場合、モデルにpublicの$incrementing
プロパティーを用意し、false
をセットしてください。
タイムスタンプ
デフォルトでEloquentはデータベース上に存在するcreated_at
(作成時間)とupdated_at
(更新時間)カラムを自動的に更新します。これらのカラムの自動更新をEloquentにしてほしくない場合は、モデルの$timestamps
プロパティーをfalse
に設定してください。
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Flight extends Model
{
/**
* モデルのタイムスタンプを更新するかの指示
*
* @var bool
*/
public $timestamps = false;
}
タイムスタンプのフォーマットをカスタマイズする必要があるなら、モデルの$dateFormat
プロパティーを設定してください。このプロパティーはデータベースに保存される日付属性のフォーマットを決めるために使用されると同時に、配列やJSONへシリアライズする時にも使われます。
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Flight extends Model
{
/**
* モデルの日付カラムの保存フォーマット
*
* @var string
*/
protected $dateFormat = 'U';
}
データベース接続
Eloquentモデルはデフォルトとして、アプリケーションに設定されているデフォルトのデータベース接続を使用します。モデルで異なった接続を指定したい場合は、$connection
プロパティーを使用します。
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Flight extends Model
{
/**
* モデルで使用するコネクション名
*
* @var string
*/
protected $connection = 'connection-name';
}
モデルの取得
モデルと対応するデータベーステーブルを作成したら、データベースからデータを取得できるようになりました。各Eloquentモデルは、対応するテーブルのデータベースへすらすらとクエリできるようにしてくれるクエリビルダだと考えてください。例を見てください。
<?php
namespace App\Http\Controllers;
use App\Flight;
use App\Http\Controllers\Controller;
class FlightController extends Controller
{
/**
* 利用可能な全フライトの一覧を表示
*
* @return Response
*/
public function index()
{
$flights = Flight::all();
return view('flight.index', ['flights' => $flights]);
}
}
カラム値に対するアクセス
Eloquentモデルインスタンスを入手したら、モデルのカラム値には対応するプロパティとしてアクセスできます。たとえばクエリの結果の各Flight
インスタンスをループで取得し、name
カラムの値をechoしてみましょう。
foreach ($flights as $flight) {
echo $flight->name;
}
制約の追加
Eloquentのall
メソッドはモデルテーブルの全レコードを結果として返します。Eloquentモデルはクエリビルダとしても動作しますのでクエリに制約を付け加えることもでき、結果を取得するにはget
メソッドを使用します。
$flights = App\Flight::where('active', 1)
->orderBy('name', 'desc')
->take(10)
->get();
注目: Eloquentモデルはクエリビルダですから、クエリビルダで使用できる全メソッドを確認しておくべきでしょう。Eloquentクエリでどんなメソッドも使用できます。
コレクション
複数の結果を取得するall
やget
のようなEloquentメソッドは、Illuminate\Database\Eloquent\Collection
インスタンスを返します。Collection
クラスはEloquent結果を操作する多くの便利なクラスを提供しています。もちろんこのコレクションは配列のようにループさせることもできます。
foreach ($flights as $flight) {
echo $flight->name;
}
結果の分割
数千のEloquentレコードを処理する必要がある場合はchunk
コマンドを利用してください。chunk
メソッドはEloquentモデルの「塊(chunk)」を取得し、引数の「クロージャ」に渡します。chunk
メソッドを使えば大きな結果を操作するときのメモリを節約できます。
Flight::chunk(200, function ($flights) {
foreach ($flights as $flight) {
//
}
});
最初の引数には「チャンク(塊)」ごとにいくつのレコードを処理するかを渡します。2番めの引数にはクロージャを渡し、そのデータベースからの結果をチャンクごとに処理するコードを記述します。
注意 各チャンクごとにデータベースクエリは再実行されます。
カーソルの使用
cursor
メソッドにより、カーソルを使用し、データベースレコード全体を繰り返し処理できます。大量のデータを処理する場合、cursor
メソッドを使用すると、大幅にメモリ使用量を減らせるでしょう。
foreach (Flight::where('foo', 'bar')->cursor() as $flight) {
//
}
1モデル/集計の取得
もちろん指定したテーブルの全レコードを取得することに加え、find
とfirst
を使い1レコードだけを取得できます。モデルのコレクションの代わりに、これらのメソッドは1モデルインスタンスを返します。
// 主キーで指定したモデル取得
$flight = App\Flight::find(1);
// クエリー条件にマッチした最初のレコード取得
$flight = App\Flight::where('active', 1)->first();
また、主キーの配列をfind
メソッドに渡し、呼び出すこともできます。一致したレコードのコレクションが返されます。
$flights = App\Flight::find([1, 2, 3]);
Not Found例外
モデルが見つからない時に、例外を投げたい場合もあります。これは特にルートやコントローラーの中で便利です。findOrFail
メソッドとクエリの最初の結果を取得するfirstOrFail
メソッドは、該当するレコードが見つからない場合にIlluminate\Database\Eloquent\ModelNotFoundException
例外を投げます。
$model = App\Flight::findOrFail(1);
$model = App\Flight::where('legs', '>', 100)->firstOrFail();
この例外がキャッチされないと自動的に404
HTTPレスポンスがユーザに送り返されますので、これらのメソッドを使用すればわざわざ明確に404
レスポンスを返すコードを書く必要はありません。
Route::get('/api/flights/{id}', function ($id) {
return App\Flight::findOrFail($id);
});
集計の取得
もちろんクエリビルダが提供しているcount
、sum
、max
や、その他の集計関数を使用することもできます。これらのメソッドは完全なモデルインスタンスではなく、最適なスカラー値を返します。
$count = App\Flight::where('active', 1)->count();
$max = App\Flight::where('active', 1)->max('price');
モデルの追加と更新
基本の追加
モデルから新しいレコードを作成するには新しいインスタンスを作成し、save
メソッドを呼び出します。
<?php
namespace App\Http\Controllers;
use App\Flight;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;
class FlightController extends Controller
{
/**
* 新しいflightインスタンスの生成
*
* @param Request $request
* @return Response
*/
public function store(Request $request)
{
// リクエストのバリデート処理…
$flight = new Flight;
$flight->name = $request->name;
$flight->save();
}
}
この例では、やって来たHTTPリクエストのname
パラメーターをApp\Flight
モデルインスタンスのname
属性に代入しています。save
メソッドが呼ばれると新しいレコードがデータベースに挿入されます。save
が呼び出された時にcreated_at
とupdated_at
タイムスタンプは自動的に設定されますので、わざわざ設定する必要はありません。
基本の更新
save
メソッドはデータベースで既に存在するモデルを更新するためにも使用されます。モデルを更新するにはまず取得する必要があり、更新したい属性をセットしてそれからsave
メソッドを呼び出します。この場合もupdated_at
タイムスタンプは自動的に更新されますので、値を指定する手間はかかりません。
$flight = App\Flight::find(1);
$flight->name = 'New Flight Name';
$flight->save();
指定したクエリに一致する複数のモデルに対し更新することもできます。以下の例ではactive
で到着地(destination
)がSan Diego
の全フライトに遅延(delayed
)のマークを付けています。
App\Flight::where('active', 1)
->where('destination', 'San Diego')
->update(['delayed' => 1]);
updata
メソッドは更新したいカラムと値の配列を受け取ります。
複数代入
一行だけで新しいモデルを保存するにはcreate
メソッドが利用できます。挿入されたモデルインスタンスがメソッドから返されます。しかしこれを利用する前にEloquentモデルを複数代入から保護するために、モデルへfillable
かguarded
属性のどちらかを設定する必要があります。
複数代入の脆弱性はリクエストを通じて予期しないHTTPパラメーターが送られた時に起き、そのパラメーターはデータベースのカラムを予期しないように変更してしまうでしょう。たとえば悪意のあるユーザがHTTPパラメーターでis_admin
パラメーターを送り、それがモデルのcreate
メソッドに対してマップされると、そのユーザは自分自身を管理者(administrator)に昇格できるのです。
ですから最初に複数代入したいモデルの属性を指定してください。モデルの$fillable
プロパティで指定できます。たとえば、Flight
モデルの複数代入でname
属性のみ使いたい場合です。
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Flight extends Model
{
/**
* 複数代入する属性
*
* @var array
*/
protected $fillable = ['name'];
}
複数代入する属性を指定したら、新しいレコードをデータベースに挿入するためにcreate
が利用できます。create
メソッドは保存したモデルインスタンスを返します。
$flight = App\Flight::create(['name' => 'Flight 10']);
$fillable
が複数代入時における属性の「ホワイトリスト」として動作する一方、$guarded
の使用を選ぶことができます。$guarded
プロパティーは複数代入したくない属性の配列です。配列に含まれない他の属性は全部複数台入可能です。そのため$guarded
は「ブラックリスト」として働きます。もちろん$fillable
か$guarded
のどちらか一方を使用してください。両方一度には使えません。
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Flight extends Model
{
/**
* 複数代入しない属性
*
* @var array
*/
protected $guarded = ['price'];
}
この例ではprice
以外の全属性で複数代入ができます。
他の生成メソッド
他にも属性の複数代入可能な生成メソッドが2つあります。firstOrCreate
とfirstOrNew
です。firstOrCreate
メソッドは指定されたカラム/値ペアでデータベースレコードを見つけようとします。モデルがデータベースで見つからない場合、指定された属性でレコードが挿入されます。
firstOrNew
メソッドもfirstOrCreate
のように指定された属性にマッチするデータベースのレコードを見つけようとします。しかしモデルが見つからない場合、新しいモデルインスタンスが返されます。firstOrNew
が返すモデルはデータベースに保存されていないことに注目です。保存するにはsave
メソッドを呼び出す必要があります。
// 属性のフライトを取得するか、存在しなければ作成する
$flight = App\Flight::firstOrCreate(['name' => 'Flight 10']);
// 属性のフライトか、存在しなければ新しいインスタンスを取得する
$flight = App\Flight::firstOrNew(['name' => 'Flight 10']);
モデル削除
モデルを削除するには、モデルに対しdelete
メソッドを呼び出します。
$flight = App\Flight::find(1);
$flight->delete();
キーによる既存モデルの削除
上記の例ではdelete
メソッドを呼び出す前にデータベースからモデルを取得しています。しかしモデルの主キーが分かっている場合なら、モデルを取得せずに削除できます。destroy
メソッドを呼び出してください。
App\Flight::destroy(1);
App\Flight::destroy([1, 2, 3]);
App\Flight::destroy(1, 2, 3);
クエリによるモデル削除
もちろん一連のモデルをクエリを実行し削除することもできます。次の例はactiveではない印を付けられたフライトを削除しています。
$deletedRows = App\Flight::where('active', 0)->delete();
ソフトデリート
実際にデータベースからレコードを削除する方法に加え、Eloquentはモデルの「ソフトデリート」も行えます。モデルがソフトデリートされても実際にはデータベースのレコードから削除されません。代わりにそのモデルにdeleted_at
属性がセットされ、データベースへ書き戻されます。モデルのdeleted_at
の値がNULLでない場合、ソフトデリートされています。モデルのソフトでリートを有効にするにはモデルにIlluminate\Database\Eloquent\SoftDeletes
トレイトを使い、deleted_at
カラムを$dates
プロパティに追加します。
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
class Flight extends Model
{
use SoftDeletes;
/**
* 日付へキャストする属性
*
* @var array
*/
protected $dates = ['deleted_at'];
}
もちろんデータベーステーブルにもdeleted_at
カラムを追加する必要があります。Laravelスキーマビルダにはこのカラムを作成するメソッドが存在しています。
Schema::table('flights', function ($table) {
$table->softDeletes();
});
これでモデルに対しdelete
メソッドを使用すれば、deleted_at
カラムに現在の時間がセットされます。ソフトデリートされたモデルに対しクエリがあっても、削除済みのモデルはクエリ結果に含まれません。
指定されたモデルインスタンスがソフトデリートされているかを確認するには、trashed
メソッドを使います。
if ($flight->trashed()) {
//
}
ソフトデリート済みモデルのクエリ
ソフトデリート済みモデルも含める
前述のようにソフトデリートされたモデルは自動的にクエリの結果から除外されます。しかし結果にソフトデリート済みのモデルを含めるように強制したい場合は、クエリにwithTrashed
メソッドを使ってください。
$flights = App\Flight::withTrashed()
->where('account_id', 1)
->get();
withTrashed
メソッドはリレーションのクエリにも使えます。
$flight->history()->withTrashed()->get();
ソフトデリート済みモデルのみの取得
onlyTrashed
メソッドによりソフトデリート済みのモデルのみを取得できます。
$flights = App\Flight::onlyTrashed()
->where('airline_id', 1)
->get();
ソフトデリートの解除
時にはソフトデリート済みのモデルを「未削除」に戻したい場合も起きます。ソフトデリート済みモデルを有効な状態に戻すには、そのモデルインスタンスに対しrestore
メソッドを使ってください。
$flight->restore();
複数のモデルを手っ取り早く未削除に戻すため、クエリにrestore
メソッドを使うこともできます。
App\Flight::withTrashed()
->where('airline_id', 1)
->restore();
withTrashed
メソッドと同様、restore
メソッドはリレーションに対しても使用できます。
$flight->history()->restore();
モデルの完全削除
データベースからモデルを本当に削除する場合もあるでしょう。データベースからソフトデリート済みモデルを永久に削除するにはforceDelete
メソッドを使います。
// 1モデルを完全に削除する
$flight->forceDelete();
// 関係するモデルを全部完全に削除する
$flight->history()->forceDelete();
クエリスコープ
グローバルスコープ
グローバルスコープにより、指定したモデルの全クエリに対して、制約を付け加えることができます。Laravel自身のソフトデリート機能は、「削除されていない」モデルをデータベースから取得するためにグローバルスコープを使用しています。独自のグローバルスコープを書くことにより、特定のモデルのクエリに制約を確実に、簡単に、便利に指定できます。
グローバルスコープの記述
グローバルスコープは簡単に書けます。Illuminate\Database\Eloquent\Scope
インターフェイスを実装したクラスを定義します。このインターフェイスは、apply
メソッドだけを実装するように要求しています。apply
メソッドは必要に応じ、where
制約を追加します。
<?php
namespace App\Scopes;
use Illuminate\Database\Eloquent\Scope;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;
class AgeScope implements Scope
{
/**
* Eloquentクエリビルダへ適用するスコープ
*
* @param \Illuminate\Database\Eloquent\Builder $builder
* @param \Illuminate\Database\Eloquent\Model $model
* @return void
*/
public function apply(Builder $builder, Model $model)
{
return $builder->where('age', '>', 200);
}
}
デフォルトのLaravelアプリケーションには、スコープのためのフォルダは用意されていません。Laravelアプリケーションのapp
ディレクトリ下に、自由にScopes
フォルダーを作成してください。
グローバルスコープの適用
モデルにグローバルスコープを適用するには、そのモデルのboot
メソッドをオーバライドし、addGlobalScope
メソッドを呼び出します。
<?php
namespace App;
use App\Scopes\AgeScope;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* モデルの「初期起動」メソッド
*
* @return void
*/
protected static function boot()
{
parent::boot();
static::addGlobalScope(new AgeScope);
}
}
スコープを追加した後から、User::all()
は以下のクエリを生成するようになります。
select * from `users` where `age` > 200
クロージャによるグローバルスコープ
Eloquentではクロージャを使ったグローバルスコープも定義できます。独立したクラスを使うだけの理由がない、簡単なスコープを使いたい場合、特に便利です。
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;
class User extends Model
{
/**
* モデルの「初期起動」メソッド
*
* @return void
*/
protected static function boot()
{
parent::boot();
static::addGlobalScope('age', function(Builder $builder) {
$builder->where('age', '>', 200);
});
}
}
addGlobalScope
の最初の引数は、スコープを削除する時に使用する識別子です。
User::withoutGlobalScope('age')->get();
グローバルスコープの削除
特定のクエリからグローバルスコープを削除した場合は、withoutGlobalScope
メソッドを使います。
User::withoutGlobalScope(AgeScope::class)->get();
複数、もしくは全部のグローバルスコープを削除したい場合も、withoutGlobalScopes
メソッドが使えます。
User::withoutGlobalScopes()->get();
User::withoutGlobalScopes([FirstScope::class, SecondScope::class])->get();
ローカルスコープ
ローカルスコープによりアプリケーション全体で簡単に再利用可能な、一連の共通制約を定義できます。例えば、人気のある(popular)ユーザを全員取得する必要が、しばしばあるとしましょう。スコープを定義するには、scope
を先頭につけた、Eloquentモデルのメソッドを定義するだけです。
スコープはいつもクエリビルダインスタンスを返します。
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* 人気のあるユーザだけに限定するクエリスコープ
*
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopePopular($query)
{
return $query->where('votes', '>', 100);
}
/**
* アクティブなユーザだけに限定するクエリスコープ
*
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeActive($query)
{
return $query->where('active', 1);
}
}
クエリスコープの使用
スコープが定義できたらモデルのクエリ時にスコープメソッドを呼び出せます。しかしメソッドを呼び出すときにscope
プレフィックスを付ける必要はありません。様々なスコープをチェーンでつなぎ呼び出すこともできます。例を見てください。
$users = App\User::popular()->active()->orderBy('created_at')->get();
動的スコープ
引数を受け取るスコープを定義したい場合もあるでしょう。スコープにパラメーターを付けるだけです。スコープパラメーターは$query
引数の後に定義しする必要があります。
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* 指定したタイプのユーザーだけを含むクエリーのスコープ
*
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeOfType($query, $type)
{
return $query->where('type', $type);
}
}
これでスコープを呼び出すときにパラメーターを渡せます。
$users = App\User::ofType('admin')->get();
イベント
Eloquentモデルは多くのイベントを発行します。creating
、created
、updating
、updated
、saving
、saved
、deleting
、deleted
、restoring
、restored
のメソッドを利用し、モデルのライフサイクルの様々な時点をフックすることができます。イベントにより特定のモデルクラスが保存されたりアップデートされたりするたび、簡単にコードを実行できるようになります。
基本的な使用法
いつでも新しいアイテムが最初に保存される場合にcreating
とcreated
イベントが発行されます。新しくないアイテムにsave
メソッドが呼び出されるとupdating
とupdated
イベントが発行されます。どちらの場合にもsaving
とsaved
イベントは発行されます。
例としてサービスプロバイダでEloquentイベントリスナを定義してみましょう。イベントリスナの中で指定されたモデルに対しisValid
メソッドを呼び出し、モデルが有効でなければfalse
が返されます。Eloquentイベントリスナがfalse
を返すとsave
/update
操作はキャンセルされます。
<?php
namespace App\Providers;
use App\User;
use Illuminate\Support\ServiceProvider;
class AppServiceProvider extends ServiceProvider
{
/**
* アプリケーションサービスの初期起動処理
*
* @return void
*/
public function boot()
{
User::creating(function ($user) {
if ( ! $user->isValid()) {
return false;
}
});
}
/**
* サービスプロバイダの登録
*
* @return void
*/
public function register()
{
//
}
}