Eloquent ORM ―― 調(diào)整器

Eloquent ORM —— 訪問器&修改器

1、簡介

訪問器屬性。例如，你可能想要使用Laravel加密器對存儲在數(shù)據(jù)庫中的數(shù)據(jù)進行加密，并且在Eloquent模型中訪問時自動進行解密。

除了自定義訪問器和修改器，Eloquent還可以自動轉(zhuǎn)換日期字段為Carbon實例甚至將文本轉(zhuǎn)換為JSON。

2、訪問器 & 修改器

2.1 定義訪問器

要定義一個訪問器，需要在模型中創(chuàng)建一個getFooAttribute方法，其中Foo是你想要訪問的字段名（使用駝峰式命名規(guī)則）。在本例中，我們將會為first_name屬性定義一個訪問器，該訪問器在獲取first_name的值時被Eloquent自動調(diào)用：

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model{
    /**
     * 獲取用戶的名字
     *
     * @param  string  $value
     * @return string
     */
    public function getFirstNameAttribute($value)
    {
        return ucfirst($value);
    }
}

正如你所看到的，該字段的原生值被傳遞給訪問器，然后返回處理過的值。要訪問該值只需要簡單訪問first_name即可：

$user = App\User::find(1);
$firstName = $user->first_name;

2.2 定義修改器

要定義一個修改器，需要在模型中定義setFooAttribute方法，其中Foo是你想要訪問的字段（使用駝峰式命名規(guī)則）。接下來讓我們?yōu)?code>first_name屬性定義一個修改器，當我們?yōu)槟Ｐ蜕系?code>first_name賦值時該修改器會被自動調(diào)用：

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model{
    /**
     * 設(shè)置用戶的名字
     *
     * @param  string  $value
     * @return string
     */
    public function setFirstNameAttribute($value)
    {
        $this->attributes['first_name'] = strtolower($value);
    }
}

該修改器獲取要被設(shè)置的屬性值，允許你操縱該值并設(shè)置Eloquent模型內(nèi)部屬性值為操作后的值。例如，如果你嘗試設(shè)置Sally的first_name屬性：

$user = App\User::find(1);
$user->first_name = 'Sally';

在本例中，setFirstNameAttribute方法會被調(diào)用，傳入?yún)?shù)為Sally，修改器會對其調(diào)用strtolower函數(shù)并將處理后的值設(shè)置為內(nèi)部屬性的值。

3、日期修改器

默認情況下，Eloquent將會轉(zhuǎn)化created_at和updated_at列的值為Carbon實例，該類繼承自PHP原生的Datetime類，并提供了各種有用的方法。

你可以自定義哪些字段被自動調(diào)整修改，甚至可以通過重寫模型中的$dates屬性完全禁止調(diào)整：

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model{
    /**
     * 應(yīng)該被調(diào)整為日期的屬性
     *
     * @var array
     */
    protected $dates = ['created_at', 'updated_at', 'disabled_at'];
}

如果字段是日期格式時，你可以將其值設(shè)置為UNIX時間戳，日期字符串（Y-m-d），日期-時間字符串，Datetime/Carbon實例，日期的值將會自動以正確格式存儲到數(shù)據(jù)庫中：

$user = App\User::find(1);
$user->disabled_at = Carbon::now();
$user->save();

正如上面提到的，當獲取被羅列在$dates數(shù)組中的屬性時，它們會被自動轉(zhuǎn)化為Carbon實例，允許你在屬性上使用任何Carbon的方法：

$user = App\User::find(1);
return $user->disabled_at->getTimestamp();

如果你需要自定義時間戳格式，在模型中設(shè)置$dateFormat屬性，該屬性決定日期屬性將以何種格式存儲在數(shù)據(jù)庫中、以及序列化為數(shù)組或JSON時的格式：

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class Flight extends Model{
    /**
     * 模型日期的存儲格式
     *
     * @var string
     */
    protected $dateFormat = 'U';
}

4、屬性轉(zhuǎn)換

模型中的$casts屬性提供了便利方法轉(zhuǎn)換屬性到通用數(shù)據(jù)類型。$casts屬性是數(shù)組格式，其鍵是要被轉(zhuǎn)換的屬性名稱，其值時你想要轉(zhuǎn)換的類型。目前支持的轉(zhuǎn)換類型包括：integer,?real,?float,?double,?string,?boolean,?object和array。

例如，讓我們轉(zhuǎn)換is_admin屬性，將其由integer類型轉(zhuǎn)換為boolean類型：

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model{
    /**
     * 應(yīng)該被轉(zhuǎn)化為原生類型的屬性
     *
     * @var array
     */
    protected $casts = [
        'is_admin' => 'boolean',
    ];
}

現(xiàn)在，is_admin屬性在被訪問時總是被轉(zhuǎn)換為boolean，即使底層存儲在數(shù)據(jù)庫中的值是integer：

$user = App\User::find(1);

if ($user->is_admin) {
    //
}

4.1 數(shù)組轉(zhuǎn)換

array類型轉(zhuǎn)換在處理被存儲為序列化JSON的字段是特別有用，例如，如果數(shù)據(jù)庫有一個TEXT字段類型包含了序列化JSON，添加array類型轉(zhuǎn)換到該屬性將會在Eloquent模型中訪問其值時自動將其反序列化為PHP數(shù)組：

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model{
    /**
     * 應(yīng)該被轉(zhuǎn)化為原生類型的屬性
     *
     * @var array
     */
    protected $casts = [
        'options' => 'array',
    ];
}

類型轉(zhuǎn)換被定義后，就可以訪問options屬性，它將會自動從JSON反序列化為PHP數(shù)組，當你設(shè)置options屬性的值時，給定數(shù)組將會自動轉(zhuǎn)化為JSON以供存儲：

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