查詢作用域
全域性作用域
全域性作用域允許你對給定模型的所有查詢新增約束。使用全域性作用域功能可以為模型的所有操作增加約束。
軟刪除功能實際上就是利用了全域性作用域功能
實現一個全域性作用域功能只需要定義一個實現Illuminate\Database\Eloquent\Scope介面的類，該介面只有一個方法apply，在該方法中增加查詢需要的約束
<?php
namespace App\Scopes;
use Illuminate\Database\Eloquent\Scope;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Builder;
class AgeScope implements Scope
{
/**
* Apply the scope to a given Eloquent query builder.
*
* @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);
}
}在模型的中，需要覆蓋其boot方法，在該方法中增加addGlobalScope
<?php
namespace App;
use App\Scopes\AgeScope;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* The "booting" method of the model.
*
* @return void
*/
protected static function boot()
{
parent::boot();
static::addGlobalScope(new AgeScope);
}
}新增全域性作用域之後，User::all()操作將會產生如下等價sql
select * from `users` where `age` > 200也可以使用匿名函式新增全域性約束
static::addGlobalScope('age', function(Builder $builder) {
$builder->where('age', '>', 200);
});查詢中要移除全域性約束的限制，使用withoutGlobalScope方法
// 只移除age約束
User::withoutGlobalScope('age')->get();
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
{
/**
* Scope a query to only include popular users.
*
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopePopular($query)
{
return $query->where('votes', '>', 100);
}
/**
* Scope a query to only include active users.
*
* @return \Illuminate\Database\Eloquent\Builder
*/
public function scopeActive($query)
{
return $query->where('active', 1);
}
}使用上述新增的本地約束查詢，只需要在查詢中使用scope字首的方法，去掉scope字首即可
$users = App\User::popular()->active()->orderBy('created_at')->get();本地作用域方法是可以接受引數的
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
使用場景
假設我們希望儲存使用者的時候對使用者進行校驗，校驗透過後才允許儲存到資料庫，可以在服務提供者中為模型的事件繫結監聽
<?php
namespace App\Providers;
use App\User;
use Illuminate\Support\ServiceProvider;
class AppServiceProvider extends ServiceProvider
{
/**
* Bootstrap any application services.
*
* @return void
*/
public function boot()
{
User::creating(function ($user) {
if ( ! $user->isValid()) {
return false;
}
});
}
/**
* Register the service provider.
*
* @return void
*/
public function register()
{
//
}
}上述服務提供者物件中，在框架啟動時會監聽模型的creating事件，當儲存使用者之間檢查使用者資料的合法性，如果不合法，返回false，模型資料不會被持久化到資料。
返回false會阻止模型的
save/update操作
序列化
當構建JSON API的時候，經常會需要轉換模型和關係為陣列或者json。Eloquent提供了一些方法可以方便的來實現資料型別之間的轉換。
轉換模型/集合為陣列 - toArray()
$user = App\User::with('roles')->first();
return $user->toArray();
$users = App\User::all();
return $users->toArray();轉換模型為json - toJson()
$user = App\User::find(1);
return $user->toJson();
$user = App\User::find(1);
return (string) $user;隱藏屬性
有時某些欄位不應該被序列化，比如使用者的密碼等，使用$hidden欄位控制那些欄位不應該被序列化
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* The attributes that should be hidden for arrays.
*
* @var array
*/
protected $hidden = ['password'];
}隱藏關聯關係的時候，使用的是它的方法名稱，不是動態的屬性名
也可以使用$visible指定會被序列化的白名單
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* The attributes that should be visible in arrays.
*
* @var array
*/
protected $visible = ['first_name', 'last_name'];
}有時可能需要某個隱藏欄位被臨時序列化，使用makeVisible方法
return $user->makeVisible('attribute')->toArray();為json追加值
有時需要在json中追加一些資料庫中不存在的欄位，使用下列方法，現在模型中增加一個get方法
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* The accessors to append to the model's array form.
*
* @var array
*/
protected $appends = ['is_admin'];
/**
* Get the administrator flag for the user.
*
* @return bool
*/
public function getIsAdminAttribute()
{
return $this->attributes['admin'] == 'yes';
}
}方法簽名為getXXXAttribute格式，然後為模型的$appends欄位設定欄位名。
Mutators
在Eloquent模型中，Accessor和Mutator可以用來對模型的屬性進行處理，比如我們希望儲存到表中的密碼欄位要經過加密才行，我們可以使用Laravel的加密工具自動的對它進行加密。
Accessors & Mutators
accessors
要定義一個accessor，需要在模型中建立一個名稱為getXxxAttribute的方法，其中的Xxx是駝峰命名法的欄位名。
假設我們有一個欄位是first_name，當我們嘗試去獲取first_name的值的時候，getFirstNameAttribute方法將會被自動的呼叫
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* Get the user's first name.
*
* @param string $value
* @return string
*/
public function getFirstNameAttribute($value)
{
return ucfirst($value);
}
}在訪問的時候，只需要正常的訪問屬性就可以
$user = App\User::find(1);
$firstName = $user->first_name;mutators
建立mutators與accessorsl類似，建立名為setXxxAttribute的方法即可
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* Set the user's first name.
*
* @param string $value
* @return string
*/
public function setFirstNameAttribute($value)
{
$this->attributes['first_name'] = strtolower($value);
}
}賦值方式
$user = App\User::find(1);
$user->first_name = 'Sally';屬性轉換
模型的$casts屬性提供了一種非常簡便的方式轉換屬性為常見的資料型別，在模型中，使用$casts屬性定義一個陣列，該陣列的key為要轉換的屬性名稱，value為轉換的資料型別，當前支援integer, real, float, double, string, boolean, object, array,collection, date, datetime, 和 timestamp。
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* The attributes that should be casted to native types.
*
* @var array
*/
protected $casts = [
'is_admin' => 'boolean',
];
}陣列型別的轉換時非常有用的，我們在資料庫中儲存json資料的時候，可以將其轉換為陣列形式。
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
/**
* The attributes that should be casted to native types.
*
* @var array
*/
protected $casts = [
'options' => 'array',
];
}從配置陣列轉換的屬性取值或者賦值的時候都會自動的完成json和array的轉換
$user = App\User::find(1);
$options = $user->options;
$options['key'] = 'value';
$user->options = $options;
$user->save();參考：
本作品採用《CC 協議》，轉載必須註明作者和本文連結