Laravel (5,7) красноречивые мутаторы

Вступление

Мутаторы и методы доступа позволяют форматировать значения атрибутов Eloquent при извлечении или установке их в экземплярах модели. Например, если вы хотите использовать шифратор laravel для шифрования значения, пока оно хранится в базе данных, а затем автоматически расшифровывать атрибут при доступе к нему в модели Eloquent.

Помимо пользовательских мутаторов и аксессоров, Eloquent также может автоматически преобразовывать поля даты в экземпляры Carbon или преобразовывать текстовые поля в JSON.

Аксессоры и мутаторы

Определение аксессора

Если вы хотите определить метод доступа, вам следует создать метод getFooAttribute в вашей модели, где Foo - это «вогнутое» имя столбца, к которому вы хотите получить доступ. В приведенном ниже примере мы определим метод доступа для атрибута first_name. Eloquent автоматически вызывает метод доступа при попытке получить значение атрибута first_name:

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
    /**
     * Get the first name of the user.
     *
     * @param  string  $value
     * @return string
     */
    public function getFirstNameAttribute($value)
    {
        return ucfirst($value);
    }
}

Как видно выше, исходное значение столбца будет передано аксессору, это позволяет вам манипулировать и возвращать значение. Чтобы получить доступ к значению метода доступа, вы можете получить доступ к атрибуту first_name в экземпляре модели:

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

Вы также можете вернуть новые вычисленные значения из существующих атрибутов, используя методы доступа:

/**
 * Get the full name of the user.
 *
 * @return string
 */
public function getFullNameAttribute()
{
    return "{$this->first_name} {$this->last_name}";
}

Определение Мутатора

Если вы хотите определить мутатор, вы должны определить метод setFooAttribute в вашей модели, где Foo - это "вогнутое" имя столбца, к которому вы хотите получить доступ. Мы определим мутатор для атрибута first_name. Этот мутатор вызывается автоматически, когда мы пытаемся установить значение атрибута first_name в модели:

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
    /**
     * Set the first name of the user.
     *
     * @param  string  $value
     * @return void
     */
    public function setFirstNameAttribute($value)
    {
        $this->attributes['first_name'] = strtolower($value);
    }
}

Мутатор получит значение, установленное для атрибута, это позволяет вам манипулировать этим значением, а затем устанавливать это значение во внутреннем свойстве $ attribute модели Eloquent. Итак, если мы попытаемся установить для атрибута first_name значение Sally:

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

В этом случае функция setFirstNameAttribute вызывается со значением Sally. Таким образом, мутатор применяет функцию strtolower к имени и устанавливает полученное значение во внутреннем массиве $ attribute.

Дата Мутаторы

По умолчанию Eloquent преобразует столбцы create_at и updated_at в экземпляры Carbon, что расширит класс PHP DateTime, а затем предоставит набор полезных методов. Вы можете добавить дополнительные атрибуты даты, установив свойство $ date вашей модели:

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
    /**
     * The attributes that should be mutated to dates.
     *
     * @var array
     */
    protected $dates = [
        'seen_at',
    ];
}

Всякий раз, когда столбец считается датой, вы можете установить в качестве его значения метку времени UNIX, строку даты (Ymd), строку даты-времени или экземпляр DateTime / Carbon. Значение даты корректно конвертируется и сохраняется в базе данных:

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

Когда вы извлекаете атрибуты, перечисленные в свойстве $ date, они автоматически приводятся к экземплярам Carbon, что позволяет вам использовать любые методы Carbon для ваших атрибутов:

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

Форматы даты

По умолчанию метки времени будут отформатированы как «Ymd H: i: s». Если необходимо настроить формат отметки времени, установите свойство $ dateFormat для вашей модели. Это свойство будет определять способ хранения атрибутов даты в базе данных, а также их формат, когда модель будет сериализована в массив или JSON:

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Flight extends Model
{
    /**
     * The storage format of the model's date columns.
     *
     * @var string
     */
    protected $dateFormat ='U';
}

Кастинг атрибутов

Свойство $ casts в нашей модели предоставляет удобный метод преобразования атрибутов в распространенные типы данных. Свойство $ casts должно быть массивом, где ключ - это имя атрибута, который преобразуется, а значение - это тип, к которому мы хотим преобразовать столбец. Поддерживаемые типы приведения: целое, действительное, двойное, число с плавающей запятой, десятичное число: <цифры>, строка, логическое значение, объект, массив, коллекция, дата, время и дата. Когда мы приводим десятичное число, мы должны определить количество цифр, например. десятичное: 2

Например, давайте приведем атрибут is_admin, хранящийся в нашей базе данных, как целое число (0 или 1) к логическому значению:

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
    /**
     * The attributes that are cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'is_admin' => 'boolean',
    ];
}

Теперь атрибут is_admin всегда приводится к логическому значению при обращении к нему, даже если базовое значение хранится в базе данных как целое число:

$user = App\User::find(1);
if ($user->is_admin) {
    //
}

Массив и JSON Casting

Тип преобразования массива очень полезен, когда вы работаете со столбцами, которые хранятся в виде сериализованного JSON. Например, если ваша база данных содержит тип поля JSON или TEXT с сериализованным JSON, добавление массива, приведенного к этому атрибуту, автоматически десериализует атрибут в массив PHP при доступе к нему в модели Eloquent:

<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class User extends Model
{
    /**
     * The attributes that should be cast to native types.
     *
     * @var array
     */
    protected $casts = [
        'options' => 'array',
    ];
}

когда приведение приведено, вы можете получить доступ к атрибуту options, и он автоматически десериализуется из JSON в массив PHP. Когда вы устанавливаете значение атрибута options, данный массив автоматически сериализуется обратно в JSON для хранения:

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

Дата кастинга

Когда вы используете тип приведения даты или даты и времени, вы можете указать формат даты. Этот формат используется, когда модель сериализуется в массив или JSON:

/**
 * The attributes that should be cast to native types.
 *
 * @var array
 */
protected $casts = [
    'created_at' => 'datetime:Y-m-d',
];