Skip to content

Eloquent: 访问器与修改器

介绍

访问器和修改器允许您在检索或设置模型实例上的 Eloquent 属性值时进行格式化。例如,您可能希望使用 Laravel 加密器 在将值存储到数据库时加密它,然后在访问 Eloquent 模型上的属性时自动解密。

除了自定义访问器和修改器,Eloquent 还可以自动将日期字段转换为 Carbon 实例,甚至可以将文本字段 转换为 JSON

访问器与修改器

定义访问器

要定义访问器,请在模型上创建一个 getFooAttribute 方法,其中 Foo 是您希望访问的列的 "studly" 大小写名称。在此示例中,我们将为 first_name 属性定义一个访问器。尝试检索 first_name 属性的值时,Eloquent 将自动调用访问器:

php
<?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 属性:

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

$firstName = $user->first_name;

您还可以使用访问器从现有属性返回新的计算值:

php
/**
 * 获取用户的全名。
 *
 * @return string
 */
public function getFullNameAttribute()
{
    return "{$this->first_name} {$this->last_name}";
}
lightbulb

如果您希望将这些计算值添加到模型的数组 / JSON 表示中,您需要将它们附加

定义修改器

要定义修改器,请在模型上定义一个 setFooAttribute 方法,其中 Foo 是您希望访问的列的 "studly" 大小写名称。同样,我们将为 first_name 属性定义一个修改器。当我们尝试在模型上设置 first_name 属性的值时,将自动调用此修改器:

php
<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

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

修改器将接收正在设置在属性上的值,允许您操作该值并将操作后的值设置在 Eloquent 模型的内部 $attributes 属性中。例如,如果我们尝试将 first_name 属性设置为 Sally

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

$user->first_name = 'Sally';

在此示例中,setFirstNameAttribute 函数将被调用,值为 Sally。然后,修改器将对名称应用 strtolower 函数,并将其结果值设置在内部 $attributes 数组中。

日期修改器

默认情况下,Eloquent 会将 created_atupdated_at 列转换为 Carbon 实例,Carbon 扩展了 PHP 的 DateTime 类,并提供了一系列有用的方法。您可以通过设置模型的 $dates 属性来添加其他日期属性:

php
<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 应该被转换为日期的属性。
     *
     * @var array
     */
    protected $dates = [
        'seen_at',
    ];
}
lightbulb

您可以通过将模型的公共 $timestamps 属性设置为 false 来禁用默认的 created_atupdated_at 时间戳。

当某列被视为日期时,您可以将其值设置为 UNIX 时间戳、日期字符串 (Y-m-d)、日期时间字符串或 DateTime / Carbon 实例。日期的值将被正确转换并存储在您的数据库中:

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

$user->deleted_at = now();

$user->save();

如上所述,当检索列在您的 $dates 属性中列出的属性时,它们将自动被转换为 Carbon 实例,允许您在属性上使用 Carbon 的任何方法:

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

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

日期格式

默认情况下,时间戳格式为 'Y-m-d H:i:s'。如果您需要自定义时间戳格式,请在模型上设置 $dateFormat 属性。此属性决定了日期属性在数据库中的存储方式,以及模型序列化为数组或 JSON 时的格式:

php
<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

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

属性类型转换

模型上的 $casts 属性提供了一种将属性转换为常见数据类型的便捷方法。$casts 属性应该是一个数组,其中键是要转换的属性的名称,值是您希望将列转换为的类型。支持的转换类型有:integerrealfloatdoubledecimal:<digits>stringbooleanobjectarraycollectiondatedatetimetimestamp。转换为 decimal 时,您必须定义位数(decimal:2)。

为了演示属性转换,让我们将 is_admin 属性从数据库中存储为整数(01)转换为布尔值:

php
<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 应该被转换为本机类型的属性。
     *
     * @var array
     */
    protected $casts = [
        'is_admin' => 'boolean',
    ];
}

现在,当您访问 is_admin 属性时,它将始终被转换为布尔值,即使底层值在数据库中存储为整数:

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

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

数组与 JSON 转换

array 转换类型在处理存储为序列化 JSON 的列时特别有用。例如,如果您的数据库有一个 JSONTEXT 字段类型,其中包含序列化的 JSON,向该属性添加 array 转换将自动在您访问 Eloquent 模型上的属性时将其反序列化为 PHP 数组:

php
<?php

namespace App;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 应该被转换为本机类型的属性。
     *
     * @var array
     */
    protected $casts = [
        'options' => 'array',
    ];
}

一旦定义了转换,您可以访问 options 属性,它将自动从 JSON 反序列化为 PHP 数组。当您设置 options 属性的值时,给定的数组将自动序列化回 JSON 以进行存储:

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

$options = $user->options;

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

$user->options = $options;

$user->save();

日期转换

使用 datedatetime 转换类型时,您可以指定日期的格式。此格式将在 模型序列化为数组或 JSON 时使用:

php
/**
 * 应该被转换为本机类型的属性。
 *
 * @var array
 */
protected $casts = [
    'created_at' => 'datetime:Y-m-d',
];