Laravelフレームワーク - EloquentORMの基本部分を詳しく解説

Eloquent ['eləkwənt] データベース クエリ コンストラクター メソッドがモデル クラスにも使用される場合、使用法は DB::table('table name' ) の部分を省略するだけです。 Eloquent ['eləkwənt] 时，数据库查询构造器的方法对模型类也是也用的，使用上只是省略了DB::table(‘表名’)部分。

在模型中使用protected成员变量$table指定绑定的表名。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;class Flight extends Model{    /**
     * The table associated with the model.
     *
     * @var string
     */
    protected $table = &#39;my_flights&#39;;
}

Eloquent 假设每个表都有一个名为id的主键，可以通过$primaryKey成员变量覆盖该字段名称，另外，Eloquent假设主键字段是自增的整数，如果你想用非自增的主键或者非数字的主键的话，必须指定模型中的public属性$incrementing为false。
默认情况下，Eloquent期望表中存在created_at和updated_at两个字段，字段类型为timestamp，如果不希望这两个字段的话，设置$timestamps为false

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;class Flight extends Model{    /**
     * Indicates if the model should be timestamped.
     *
     * @var bool
     */
    public $timestamps = false;    /**
     * The storage format of the model&#39;s date columns.
     *
     * @var string
     */
    protected $dateFormat = &#39;U&#39;;
}

使用protected $connection = ‘connection-name’指定模型采用的数据库连接。

查询

基本查询操作#
方法all用于返回模型表中所有的结果

$flights = Flight::all();foreach ($flights as $flight) {    echo $flight->name;
}

也可以使用get方法为查询结果添加约束

$flights = App\Flight::where('active', 1)
     ->orderBy('name', 'desc')
     ->take(10)
     ->get();

可以看到，查询构造器的方法对模型类也是可以使用的

在eloquent ORM中，get和all方法查询出多个结果集，它们的返回值是一个IlluminateDatabaseEloquentCollection对象，该对象提供了多种对结果集操作的方法

public function find($key, $default = null);
public function contains($key, $value = null);
public function modelKeys();
public function diff($items)...

该对象的方法有很多，这里只列出一小部分，更多方法参考API文档 Collection 和使用说明文档。对大量结果分段处理，同样是使用chunk方法

Flight::chunk(200, function ($flights) {
    foreach ($flights as $flight) {        //
    }
});

查询单个结果

使用find和first方法查询单个结果，返回的是单个的模型实例

// 通过主键查询模型...$flight = App\Flight::find(1);

// 使用约束...$flight = App\Flight::where('active', 1)->first();

使用find方法也可以返回多个结果，以Collection对象的形式返回，参数为多个主键

$flights = App\Flight::find([1, 2, 3]);

如果查询不到结果的话，可以使用findOrFail或者firstOrFail方法，这两个方法在查询不到结果的时候会抛出IlluminateDatabaseEloquentModelNotFound<a href="http://www.php.cn/wiki/265.html" target="_blank">Exception</a>异常

$model = App\Flight::findOrFail(1);$model = App\Flight::where('legs', '>', 100)->firstOrFail();

如果没有捕获这个异常的话，laravel会自动返回给用户一个404的响应结果，因此如果希望找不到的时候返回404，是可以直接使用该方法返回的

Route::get('/api/flights/{id}', function ($id) {
    return App\Flight::findOrFail($id);
});

查询聚集函数结果

与查询构造器查询方法一样，可以使用聚集函数返回结果，常见的比如max， min，avg，sum，count等

$count = App\Flight::where('active', 1)->count();$max = App\Flight::where('active', 1)->max('price');

分页查询

分页查询可以直接使用paginate函数

LengthAwarePaginator paginate( 
    int $perPage = null, 
    array $columns = array('*'), 
    string $pageName = 'page', 
    int|null $page = null)

参数说明
参数     类型          说明
perPage int 每页显示数量
columns array   查询的列名
pageName    string  页码参数名称
page    int 当前页码

返回值为 LengthAwarePaginator 对象。

$limit = 20;$page = 1;return Enterprise::paginate($limit, ['*'], 'page', $page);

插入

基本插入操作#

插入新的数据只需要创建一个新的模型实例，然后设置模型属性，最后调用save方法即可

$flight = new Flight;$flight->name = $request->name;$flight->save();

在调用save方法的时候，会自动为created_at和updated_at字段设置时间戳，不需要手动指定

批量赋值插入#

使用create方法可以执行批量为模型的属性赋值的插入操作，该方法将会返回新插入的模型，在执行create方法之前，需要先在模型中指定fillable和guarded属性，用于防止不合法的属性赋值（例如避免用户传入的is_admin属性被误录入数据表）。

指定$fillable属性的目的是该属性指定的字段可以通过create方法插入，其它的字段将被过滤掉，类似于白名单，而$guarded则相反，类似于黑名单。

protected $fillable = ['name'];// ORprotected $guarded = ['price'];

执行create操作就只有白名单或者黑名单之外的字段可以更新了

$flight = App\Flight::create(['name' => 'Flight 10']);

除了create方法，还有两外两个方法可以使用firstOrNew和firstOrCreate。

firstOrCreate方法用来使用给定的列值对查询记录，如果查不到则插入新的。fristOrNew与firstOrCreate

モデル内の保護されたメンバー変数 $table を使用して、バインドされたテーブル名を指定します。

// 使用属性检索flight，如果不存在则创建...$flight = App\Flight::firstOrCreate(['name' => 'Flight 10']);

// 使用属性检索flight，如果不存在则创建一个模型实例...$flight = App\Flight::firstOrNew(['name' => 'Flight 10']);

Eloquent 各テーブルには id という名前の主キーがあるとします。さらに、このフィールド名は $primaryKey メンバー変数によってオーバーライドできます。 /code> code>主キー フィールドが自動インクリメント整数であると仮定します。非自動インクリメント主キーまたは非数値主キーを使用する場合は、public を指定する必要があります。 > モデル $incrementing の属性は false です。
デフォルトでは、Eloquent は 2 つのフィールド、created_at と updated_at がテーブルに存在することを想定しており、フィールド タイプは です。 >timestamp で、これら 2 つのフィールドが不要な場合は、<code>$timestamps を false に設定します

$flight = App\Flight::find(1);$flight->name = 'New Flight Name';$flight->save();

protected $connection = 'connection-name' を使用しますモデルで使用されるデータベース接続を指定します。

Query🎜🎜基本的なクエリ操作#
メソッド all は、モデル テーブル内のすべての結果を返すために使用されます🎜

App\Flight::where('active', 1)
    ->where('destination', 'San Diego')
    ->update(['delayed' => 1]);

🎜get メソッドを使用してクエリ結果に制約を追加することもできます🎜

$flight = App\Flight::find(1);$flight->delete();

🎜ご覧のとおり、クエリ コンストラクター メソッドはモデル クラスにも使用できます🎜🎜雄弁な ORM では、get メソッドと all メソッドは複数の結果セットをクエリし、その戻り値を返します値は、結果セットを操作するためのさまざまなメソッドを提供する IlluminateDatabaseEloquentCollection オブジェクトです🎜

App\Flight::destroy(1);App\Flight::destroy([1, 2, 3]);App\Flight::destroy(1, 2, 3);

🎜 このオブジェクトには多くのメソッドがありますが、ここではごく一部のみをリストします。その他のメソッドについては、 API ドキュメントのコレクションと使用法のドキュメントを参照してください。多数の結果をセグメント化して処理する場合、チャンク メソッド🎜

$deletedRows = App\Flight::where('active', 0)->delete();

🎜を使用して単一の結果をクエリします🎜🎜find メソッドと first メソッドを使用して単一の結果をクエリします結果、単一のモデル インスタンスが返されます 🎜

<?phpnamespace App;use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;class Flight extends Model{
    use SoftDeletes;    /**
     * The attributes that should be mutated to dates.
     *
     * @var array
     */
    protected $dates = [&#39;deleted_at&#39;];
}

🎜 find メソッドを使用すると、Collection オブジェクトの形式で複数の結果を返すこともできます。パラメータは複数の主キーです。 🎜

if ($flight->trashed()) {    //}

🎜 結果が見つからない場合は、findOrFail または firstOrFail メソッドを使用して、IlluminateDatabaseEloquentModelNotFound<a href="http:/" .cn target="_blank">例外</a>Exception🎜

$flights = App\Flight::withTrashed()
      ->where('account_id', 1)
      ->get();// 关联操作中也可以使用
$flight->history()->withTrashed()->get();

🎜この例外がキャッチされない場合、laravelは自動的に戻りますユーザーに 404 応答結果を返すため、必要に応じて、見つからないときに 404 が返された場合は、このメソッドを直接使用して 🎜

$flights = App\Flight::onlyTrashed()
      ->where('airline_id', 1)
      ->get();

🎜Query aggregation関数結果🎜🎜クエリ ビルダーのクエリ メソッドと同じように、集計関数を使用して、max、min、avg、sum、count などの一般的な結果を返すことができます。 etc.🎜

$flight->restore();

🎜ページングクエリ🎜🎜ページングクエリはページネーション関数を直接使用できます🎜

App\Flight::withTrashed()
    ->where('airline_id', 1)
    ->restore();// 关联操作中也可以使用
$flight->history()->restore();

🎜パラメータの説明
パラメータの型 型の説明
perPage int ページあたりの表示数量
columns array クエリの列名pageName string ページ番号パラメータ名
page int 現在のページ番号🎜🎜Return 値は LengthAwarePaginator オブジェクトです。 🎜

// Force deleting a single model instance...$flight->forceDelete();
// Force deleting all related models...$flight->history()->forceDelete();

🎜Insert🎜🎜基本的な挿入操作 #🎜🎜新しいデータを挿入するには、新しいモデルインスタンスを作成し、次にモデル属性を設定し、最後にsaveメソッドを呼び出すだけです🎜rrreee🎜saveメソッドを呼び出すとき、created_atは自動的に be フィールドと updated_at フィールドにタイムスタンプを設定します。手動で指定する必要はありません🎜🎜バッチ代入挿入#🎜🎜 create メソッドを使用して、モデル属性に値を割り当てるバッチ挿入操作を実行します。新しく挿入されたモデルを返します。 create メソッドを実行する前に、不正な属性の割り当てを防ぐためにモデルに fillable 属性と guarded 属性を指定する必要があります。 (ユーザーによって渡された is_admin 属性が誤ってデータ テーブルに入力されたことを回避するなど)。 🎜🎜 $fillable 属性を指定する目的は、この属性で指定されたフィールドを create メソッドを通じて挿入でき、他のフィールドは次のようにフィルターで除外されることです。 $guarded はその逆で、ブラックリストに似ています。 🎜rrreee🎜作成操作を実行する場合、ホワイトリストまたはブラックリストの外にあるフィールドのみを更新できます🎜rrreee🎜create メソッドに加えて、firstOrNew と firstOrCreate を使用できるメソッドが他に 2 つあります。 🎜🎜firstOrCreate メソッドは、指定された列値のペアクエリ レコード が見つからない場合は、新しいものを挿入します。 fristOrNew は firstOrCreate に似ていますが、存在しない場合は新しいモデル オブジェクトを返す点が異なります。ただし、モデルは永続化されないため、手動で作成する必要があります。メソッドをデータベースに保存するために呼び出されます。 🎜rrreee🎜Update🎜🎜基本的な更新操作 #🎜🎜save メソッドは、新しいデータを挿入するために使用できるだけでなく、データを更新するためにも使用できます。最初に更新するデータをクエリするために、model メソッドを使用するだけです。 、モデル属性を新しい値に設定し、更新するために保存すると、updated_at フィールドが自動的に更新されます。 🎜

$flight = App\Flight::find(1);$flight->name = 'New Flight Name';$flight->save();

也可使用update方法对多个结果进行更新

App\Flight::where('active', 1)
    ->where('destination', 'San Diego')
    ->update(['delayed' => 1]);

删除

基本删除操作#
使用delete方法删除模型

$flight = App\Flight::find(1);$flight->delete();

上述方法需要先查询出模型对象，然后再删除，也可以直接使用主键删除模型而不查询，使用destroy方法

App\Flight::destroy(1);App\Flight::destroy([1, 2, 3]);App\Flight::destroy(1, 2, 3);

使用约束条件删除，返回删除的行数

$deletedRows = App\Flight::where('active', 0)->delete();

软删除

软删除是在表中增加deleted_at字段，当删除记录的时候不会真实删除记录，而是设置该字段的时间戳，由Eloquent模型屏蔽已经设置该字段的数据。

要启用软删除，可以在模型中引用Illuminate\Database\Eloquent\SoftDeletes这个Trait，并且在dates属性中增加deleted_at字段。

<?phpnamespace App;use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;class Flight extends Model{
    use SoftDeletes;    /**
     * The attributes that should be mutated to dates.
     *
     * @var array
     */
    protected $dates = [&#39;deleted_at&#39;];
}

要判断一个模型是否被软删除了的话，可以使用trashed方法

if ($flight->trashed()) {    //}

查询软删除的模型#

包含软删除的模型#

如果模型被软删除了，普通查询是不会查询到该结果的，可以使用withTrashed方法强制返回软删除的结果

$flights = App\Flight::withTrashed()
      ->where('account_id', 1)
      ->get();// 关联操作中也可以使用
$flight->history()->withTrashed()->get();

只查询软删除的模型#

$flights = App\Flight::onlyTrashed()
      ->where('airline_id', 1)
      ->get();

还原软删除的模型#

查询到软删除的模型实例之后，调用restore方法还原

$flight->restore();

也可以在查询中使用

App\Flight::withTrashed()
    ->where('airline_id', 1)
    ->restore();// 关联操作中也可以使用
$flight->history()->restore();

强制删除（持久化删除）#

// Force deleting a single model instance...$flight->forceDelete();
// Force deleting all related models...$flight->history()->forceDelete();

上述操作后，数据会被真实删除。

以上がLaravelフレームワーク - EloquentORMの基本部分を詳しく解説の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。