Mutator trong Laravel 5.8

Giới thiệu

Accessor và Mutator cho phép bạn định dạng các giá trị của thuộc tính Eloquent khi bạn lấy ra hoặc set trên một instance model. Ví dụ: bạn có thể muốn sử dụng Laravel encrypter để mã hóa một giá trị trong khi lưu nó vào trong cơ sở dữ liệu, sau đó tự động giải mã khi bạn truy cập vào Eloquent model đó.

Ngoài các tuỳ biến accessors và mutator, Eloquent cũng có thể tự chuyển các trường kiểu date thành các trường hợp kiểu Carbon hoặc thậm chí chuyển trường từ text sang JSON.

Accessor và Mutator

Định nghĩa một Accessor

Để định nghĩa một accessor, hãy tạo một phương thức getFooAttribute trên model của bạn trong đó Foo là tên được đặt theo kiểu "studly" của cột mà bạn muốn truy cập. Trong ví dụ này, chúng ta sẽ định nghĩa một accessor cho thuộc tính first_name. Accessor sẽ tự động được gọi bởi Eloquent khi bạn truy xuất vào thuộc tính first_name:

<?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);
    }
}

Như bạn có thể thấy, giá trị ban đầu của cột được truyền vào accessor, cho phép bạn thao tác và trả về một giá trị khác. Để truy cập vào giá trị của accessor, bạn có thể truy cập vào thuộc tính first_name trên một instance model:

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

$firstName = $user->first_name;

Bạn cũng có thể sử dụng accessor để trả về các giá trị mới, được tính toán từ các thuộc tính hiện có:

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

{tip} Nếu bạn muốn thêm các giá trị đã được tính toán này vào mảng hoặc JSON được chuyển đổi của model, bạn sẽ cần thêm chúng vào.

Định nghĩa một Mutator

Để định nghĩa một mutator, hãy định nghĩa một phương thức setFooAttribute trên model của bạn trong đó Foo là tên được set theo kiểu "studly" của cột mà bạn muốn truy cập. Vì thế, một lần nữa, hãy định nghĩa một mutator cho thuộc tính first_name. Mutator này sẽ được gọi tự động khi bạn set một giá trị cho thuộc tính first_name trên model:

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * Set the user's first name.
     *
     * @param  string  $value
     * @return void
     */
    public function setFirstNameAttribute($value)
    {
        $this->attributes['first_name'] = strtolower($value);
    }
}

Mutator sẽ nhận vào giá trị mà đang được set cho thuộc tính đó, và cho phép bạn thao tác với giá trị đó rồi set một giá trị mới cho thuộc tính $attributes bên trong của model Eloquent. Vì vậy, ví dụ, nếu chúng ta đang set một thuộc tính first_name là Sally:

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

$user->first_name = 'Sally';

Trong ví dụ này, hàm setFirstNameAttribute sẽ được gọi với giá trị Sally. Mutator sẽ sử dụng hàm strtolower cho giá trị được đưa vào và set giá trị kết quả cho mảng $attributes.

Date Mutator

Mặc định, Eloquent sẽ chuyển đổi các cột created_at và update_at thành các instance của Carbon, đây là một class được extend từ class DateTime của PHP, cung cấp rất nhiều phương thức hữu ích. Bạn có thể thêm các thuộc tính date bằng cách set thuộc tính $dates trong model của bạn:

<?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',
    ];
}

{tip} Bạn có thể vô hiệu hóa các timestamp mặc định create_at và updated_at bằng cách set thuộc tính public $timestamps của model thành false.

Khi một cột được coi là một date, thì bạn có thể set giá trị của nó thành một UNIX timestamp, một date string (Y-m-d), date-time string, hoặc là một instance DateTime / Carbon. Các giá trị của date này sẽ được chuyển đổi và lưu chính xác vào trong cơ sở dữ liệu của bạn:

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

$user->deleted_at = now();

$user->save();

Như đã lưu ý ở trên, khi lấy các thuộc tính được liệt kê trong thuộc tính $dates của bạn, chúng sẽ tự động được chuyển sang thành các instance Carbon, cho phép bạn sử dụng bất kỳ phương thức nào của Carbon trên thuộc tính của model:

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

return $user->deleted_at->getTimestamp();

Date Formats

Mặc định, timestamp sẽ được định dạng là 'Y-m-d H:i:s'. Nếu bạn cần tùy biến định dạng timestamp này, hãy set thuộc tính $dateFormat trên model của bạn. Thuộc tính này sẽ cho biết cách mà các thuộc tính date được lưu vào trong cơ sở dữ liệu, cũng như định dạng của chúng khi model được chuyển đổi thành một mảng hoặc một định dạng 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';
}

Attribute Casting

Thuộc tính $casts trên model của bạn cung cấp một phương thức thuận tiện để chuyển đổi các thuộc tính thành các kiểu dữ liệu phổ biến. Thuộc tính $casts phải là một mảng trong đó khóa là tên của thuộc tính mà bạn muốn được chuyển và giá trị là loại bạn muốn chuyển đổi đến. Các kiểu cast được hỗ trợ là: integer, real, float, double, decimal:<digits>, string, boolean, object, array, collection, date, datetime, và timestamp. Khi chuyển sang loại decimal, bạn phải định nghĩa số ký tự, ví dụ như: (decimal:2).

Để ví dụ cho việc cast kiểu, hãy chuyển thuộc tính is_admin, được lưu trong cơ sở dữ liệu của chúng ta dưới dạng một số integer (0 và 1) thành giá trị boolean:

<?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 = [
        'is_admin' => 'boolean',
    ];
}

Bây giờ, thuộc tính is_admin sẽ luôn được chuyển thành giá trị boolean khi bạn truy cập đến nó, ngay cả khi giá trị được lưu trữ trong cơ sở dữ liệu dưới dạng một số integer:

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

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

Array và JSON Casting

Kiểu cast array đặc biệt hữu ích khi làm việc với các cột được lưu trữ dưới dạng JSON. Ví dụ: nếu cơ sở dữ liệu của bạn có một cột kiểu JSON hoặc TEXT chứa một chuỗi JSON, thì việc thêm array vào thuộc tính đó sẽ tự động giải mã các thuộc tính JSON đó thành mảng PHP khi bạn truy cập vào thuộc tính đó trên model Eloquent của bạn:

<?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',
    ];
}

Khi cast đã được định nghĩa xong, bạn có thể truy cập vào thuộc tính options và nó sẽ tự động được giải mã thuộc tính từ JSON vào một mảng PHP. Khi bạn set giá trị cho thuộc tính options, thì mảng sẽ tự động được chuyển đổi trở lại thành JSON để lưu trữ:

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

$options = $user->options;

$options['key'] = 'value';

$user->options = $options;

$user->save();

Date Casting

Khi sử dụng kiểu date hoặc datetime, bạn có thể chỉ định định dạng của date đó. Định dạng này sẽ được sử dụng khi model được chuyển hóa thành một mảng hoặc một chuỗi JSON:

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

Prologue

Getting Started

Architecture Concepts

The Basics

Frontend

Security

Digging Deeper

Database

Eloquent ORM

Testing

Official Packages