Laravel框架-EloquentORM基礎部分詳解

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 方法查詢出多個結果集，它們的傳回值是一個Illuminate\Database\Eloquent\Collection對象，該物件提供了多種對結果集操作的方法

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方法，這兩個方法在查詢不到結果的時候會拋出Illuminate\Database \Eloquent\ModelNotFound<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 目前頁碼

#傳回值為LengthAwarePaginatoratorator

物件。

$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

類似，不同在於如果不存在，它會返回一個新的模型對象，不過該模型是未經過持久化的，需要手動調用save方法持久化到資料庫.

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

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

更新

基本更新操作

#方法save不僅可以用來插入新的數據，也可以用來更新數據，只需先使用模型方法查詢出要更新的數據，設定模型屬性為新的值，然後再save就可以更新了，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中文網其他相關文章！