Laravel & Lumen之Eloquent ORM使用速查-高級部分

查詢做用域

全局做用域

全局做用域容許你對給定模型的全部查詢添加約束。使用全局做用域功能能夠爲模型的全部操做增長約束。

軟刪除功能實際上就是利用了全局做用域功能

實現一個全局做用域功能只須要定義一個實現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
{

    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
{

    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
{

    public function scopePopular($query)
    {
        return $query->where('votes', '>', 100);
    }


    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
{

    public function boot()
    {
        User::creating(function ($user) {
            if ( ! $user->isValid()) {
                return false;
            }
        });
    }


    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
{

    protected $hidden = ['password'];
}

隱藏關聯關係的時候，使用的是它的方法名稱，不是動態的屬性名

也可使用$visible指定會被序列化的白名單

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{

    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
{

    protected $appends = ['is_admin'];

    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
{

    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
{

    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
{

    protected $casts = [
        'is_admin' => 'boolean',
    ];
}

數組類型的轉換時很是有用的，咱們在數據庫中存儲json數據的時候，能夠將其轉換爲數組形式。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{

    protected $casts = [
        'options' => 'array',
    ];
}

從配置數組轉換的屬性取值或者賦值的時候都會自動的完成json和array的轉換

$user = App\User::find(1);  
$options = $user->options;
$options['key'] = 'value';
$user->options = $options;
$user->save();

---

參考：

• Eloquent: Getting Started

• Eloquent: Serialization

• Eloquent: Mutators