Laravel的Eloquent 模型的介紹

這篇文章主要介紹了關於Laravel的Eloquent 模型的介紹，有著一定的參考價值，現在分享給大家，有需要的朋友可以參考一下

Eloquent 模型

#默認繼承use Illuminate\Database\Eloquent\Model類別。

#資料表名稱與模型名稱約定：

#資料庫的表名一般使用「蛇形命名法」命名。蛇形命名法要求單字小寫，單字之間用_底線連接，且名稱是複數。

#與之對應的模型名稱，則使用「帕斯卡法「命名，即單字頭一字母都大寫。

#如果不是依上述約定，則需指明對應的資料表：

class Flight extends Model
{    /**
     * 与模型关联的数据表
     *
     * @var string     */
    protected $table = 'myflights';
}

主鍵：

模型預設資料表用id欄位作主鍵，並且是遞增整數型別。這些可以自訂：

class Flight extends Model
{    /**
     * 与模型关联的数据表     */
    protected $table = 'my_flights';    protected $primaryKey='mid';  //自定义主键字段
    
    protected $keyType = 'string';  //自定义主键类型为字串
    
    public $incrementing = false;    //主键非自增型}

時間截：

模型預設存在created_at 和updated_at兩個字段，可設定$timestamps不需兩個字段：

class Flight extends Model
{    /**
     * 该模型是否被自动维护时间戳     */
    public $timestamps = false;
}

$dateFormat屬性可自訂時間截格式儲存在資料表的格式：

class Flight extends Model
{    /**
     * 模型的日期字段的存储格式     */
    protected $dateFormat = 'U';
}

自訂時間截字段名：

<?phpclass Flight extends Model
{    const CREATED_AT = &#39;creation_date&#39;;    const UPDATED_AT = &#39;last_update&#39;;
}

自訂資料庫連線：

class Flight extends Model
{    /**
     * 此模型的连接名称。     */
    protected $connection = 'connection-name';
}

模型查詢：

use App\Flight;$flights = App\Flight::all();   //查询所有数据
foreach ($flights as $flight) {    echo $flight->name;
}$flights = App\Flight::where('active', 1)               
->orderBy('name', 'desc')               
->take(10)               
->get();             //有条件地查询数据

 all和get方法傳回 Illuminate\Database\Eloquent\Collection實例。

如果查詢大批量數據，可使用chunk，可節省記憶體：

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

或使用遊標方法cursor大幅度減少記憶體的使用：

foreach (Flight::where('foo', 'bar')->cursor() as $flight) {    //}

#查詢單一資料：

// 通过主键取回一个模型...$flight = App\Flight::find(1);
// 取回符合查询限制的第一个模型 ...
$flight = App\Flight::where('active', 1)->first();//如果找不到模型则抛出异常
//Illuminate\Database\Eloquent\ModelNotFoundException
//自动返回 HTTP 404 响应给用户
$model = App\Flight::where('legs', '>', 100)->firstOrFail();

聚合查詢：

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

#資料更新：

save方法：需要先檢索一次，再設定要更新的屬性再執行save方法，同時updated_at也會自動更新。

update方法：設定where條件，將更新欄位以鍵值對傳入update方法。該更新不會觸發saved和updated模型事件。

$flight = App\Flight::find(1);
$flight->name = 'New Flight Name';$flight->save(); //查询一次后再更新
App\Flight::where('active', 1)          
->where('destination', 'San Diego')          
->update(['delayed' => 1]); //设置条件后再批量更新

插入資料：

使用模型建立數據，需先設定$fillable或$guarded屬性。兩個屬性只能二選一。

class Flight extends Model
{    /**
     * 可以被批量赋值的属性。
     * @var array     */
    protected $fillable = ['name'];
}class Flight extends Model
{    /**
     * 不可被批量赋值的属性。可定义为空数组，表示所有属性都可以赋值。
     * @var array     */
    protected $guarded = ['price'];
}

插入資料的方法：

$flight = App\Flight::create(['name' => 'Flight 10']); //添加新记录并返回已保存的模型实例
$flight->fill(['name' => 'Flight 22']); //已有实例模型可使用fill方法

// 通过 name 属性检索航班，当结果不存在时创建它...
$flight = App\Flight::firstOrCreate(['name' => 'Flight 10']);// 通过 name 属性检索航班，当结果不存在的时候用 name 属性和 delayed 属性去创建它$flight = App\Flight::firstOrCreate(
    ['name' => 'Flight 10'], ['delayed' => 1]
);// 通过 name 属性检索航班，当结果不存在时实例化...
$flight = App\Flight::firstOrNew(['name' => 'Flight 10']);// 通过 name 属性检索航班，当结果不存在的时候用 name 属性和 delayed 属性实例化$flight = App\Flight::firstOrNew(
    ['name' => 'Flight 10'], ['delayed' => 1]
);// 如果有从奥克兰飞往圣地亚哥的航班，将价格设为 99 美元
// 如果不存在匹配的模型就创建一个
$flight = App\Flight::updateOrCreate(
    ['departure' => 'Oakland', 'destination' => 'San Diego'],
    ['price' => 99]
);

firstOrCreate：如果查不到該數據，則根據第一參數和第二參數記錄建立記錄返回已儲存的模型；

firstOrNew：如果查不到該數據，則根據第一參數和第二參數記錄創建新模型，但並未保存數據，需要手動save才可以保存數據；

updateOrCreate：根據第一參數作條件用更新第二參數數據，如果數據不存在則合併兩個參數建立記錄返回保存的模型。

刪除模型：

$flight = App\Flight::find(1);$flight->delete();  //通过查询所得的模型实例进行delete方法删除

//通过主键删除一至多条数据：App\Flight::destroy(1);
App\Flight::destroy([1, 2, 3]);
App\Flight::destroy(1, 2, 3);//通过查询条件批量删除，并返回删除条数
$deletedRows = App\Flight::where('active', 0)->delete();

批次刪除時，deleted和deleting模型事件不會被觸發。

 軟刪除：

資料表應設定deleted_at欄位。模型內引用SoftDeletes trait，並設定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 = [&#39;deleted_at&#39;]; 
}

設定了軟刪除的模型，在delete方法會設定deleted_at為目前日期和時間。查詢軟刪除的模型會自動排除被軟刪除的模型。

if ($flight->trashed()) {    //检查该模型实例是否被软删除}$flights = App\Flight::withTrashed()  //能使用查询包含软删除的数据
                ->where('account_id', 1)                ->get();$flights = App\Flight::onlyTrashed()  //只查询软删除的数据
                ->where('airline_id', 1)                ->get();$flight->restore();  //恢复被软删除的模型App\Flight::withTrashed()   //批量恢复模型，不会触发任何模型事件
        ->where('airline_id', 1)        ->restore();

軟體刪除模型使用強制刪除：

$flight->forceDelete();

#查詢作用域：

為模型新增查詢限制。分割全域和本地兩種：

全域--每個查詢都會自動加條件約束；

本地--根據需要呼叫本地約束。

全域作用域：

首先需實作scope介面類別.

<?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(&#39;age&#39;, &#39;>&#39;, 200);
    }
}

如果全域作用域要將欄位加入到查詢的select 語句中，則應該使用 addSelect 方法而不是 select，以免取代查詢的現有select。

應用全域作用域：

在模型的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);
    }
}

也可以使用閉包定義全域作用域，不必單獨定義一個類別：

class User extends Model
{    /**
     * 模型的「启动」方法
     *
     * @return void     */
    protected static function boot()
    {
        parent::boot();        
        static::addGlobalScope('age', function(Builder $builder) {            
        $builder->where('age', '>', 200);
        });
    }
}

刪除全域作用域：

User::withoutGlobalScope(AgeScope::class)->get();  //删除指定的作用域

// 删除所有的全局作用域User::withoutGlobalScopes()->get();// 删除一些全局作用域User::withoutGlobalScopes([
    FirstScope::class, SecondScope::class])->get();

本地作用域：

定义通用的约束在需要时使用。定义方法：在模型内定义scope前缀的方法。

<?php

namespace App;use Illuminate\Database\Eloquent\Model;class User extends Model
{    /**
     * 限制查询只包括受欢迎的用户。
     *
     * @return \Illuminate\Database\Eloquent\Builder     */
    public function scopePopular($query)
    {        return $query->where(&#39;votes&#39;, &#39;>&#39;, 100);
    }    /**
     * 限制查询只包括活跃的用户。
     *
     * @return \Illuminate\Database\Eloquent\Builder     */
    public function scopeActive($query)
    {        return $query->where(&#39;active&#39;, 1);
    }
}

使用方法：

$users = App\User::popular()->active()->orderBy('created_at')->get();

动态作用域：

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();

模型事件：

retrieved --查询触发

creating、created--创建触发

updating、updated--更新触发

saving、saved--创建、更新触发

deleting、deleted--删除触发

restoring、restored--恢复触发

事件指派相应的监控器：

<?php

namespace App;use App\Events\UserSaved;use App\Events\UserDeleted;
use Illuminate\Notifications\Notifiable;
use Illuminate\Foundation\Auth\User as Authenticatable;class User extends Authenticatable
{    use Notifiable;    /**
     * 模型的事件映射。
     *
     * @var array     */
    protected $dispatchesEvents = [        &#39;saved&#39; => UserSaved::class,   //触发saved事件，调用UserSaved监控器
        &#39;deleted&#39; => UserDeleted::class, //触发deleted事件，调用UserDeleted监控器    ];
}

也可所有监听放在一个观察器类中：

<?php

namespace App\Observers;use App\User;class UserObserver
{    /**
     * 监听用户创建的事件。
     *
     * @param  User  $user
     * @return void     */
    public function created(User $user)
    {        //    }    /**
     * 监听用户删除事件。
     *
     * @param  User  $user
     * @return void     */
    public function deleting(User $user)
    {        //    }
}

注册观察器：

<?php

namespace App\Providers;use App\User;use App\Observers\UserObserver;
use Illuminate\Support\ServiceProvider;class AppServiceProvider extends ServiceProvider
{    /**
     * 运行所有应用.
     *
     * @return void     */
    public function boot()
    {
        User::observe(UserObserver::class);
    }
｝

以上就是本文的全部内容，希望对大家的学习有所帮助，更多相关内容请关注PHP中文网！

相关推荐：

 Laravel 开发支付宝支付与提现转账的方法

以上是Laravel的Eloquent 模型的介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章！