Eloquent：修改器 & 类型转换

简介
访问器与修改器
- 定义访问器
- 定义修改器
属性类型转换
自定义类型转换

简介

访问器、修改器和属性类型转换允许你在获取或设置模型实例上的 Eloquent 属性值时对其进行转换。例如，你可能希望使用 Laravel 加密器在将值存储到数据库时对其进行加密，然后在访问 Eloquent 模型上的该属性时自动解密。或者，你可能希望将存储在数据库中的 JSON 字符串在通过 Eloquent 模型访问时转换为数组。

访问器与修改器

定义访问器

访问器在访问 Eloquent 属性值时对其进行转换。要定义访问器，请在模型上创建一个受保护的方法来表示可访问的属性。此方法名称应对应于实际底层模型属性/数据库列的“驼峰式”表示（如果适用）。

在此示例中，我们将为 first_name 属性定义一个访问器。当尝试获取 first_name 属性的值时，Eloquent 将自动调用该访问器。所有属性访问器/修改器方法必须声明返回类型提示 Illuminate\Database\Eloquent\Casts\Attribute：

php

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 获取用户的名字。
     */
    protected function firstName(): Attribute
    {
        return Attribute::make(
            get: fn (string $value) => ucfirst($value),
        );
    }
}

所有访问器方法都返回一个 Attribute 实例，该实例定义了如何访问以及可选地如何修改属性。在此示例中，我们仅定义了如何访问属性。为此，我们向 Attribute 类构造函数提供了 get 参数。

如你所见，列的原始值被传递给访问器，允许你操作并返回该值。要访问访问器的值，你只需访问模型实例上的 first_name 属性：

php

use App\Models\User;

$user = User::find(1);

$firstName = $user->first_name;

NOTE

如果你希望将这些计算值添加到模型的数组 / JSON 表示中，你需要将它们追加。

从多个属性构建值对象

有时你的访问器可能需要将多个模型属性转换为单个“值对象”。为此，你的 get 闭包可以接受第二个参数 $attributes，该参数将自动提供给闭包，并包含模型当前所有属性的数组：

php

use App\Support\Address;
use Illuminate\Database\Eloquent\Casts\Attribute;

/**
 * 与用户的地址交互。
 */
protected function address(): Attribute
{
    return Attribute::make(
        get: fn (mixed $value, array $attributes) => new Address(
            $attributes['address_line_one'],
            $attributes['address_line_two'],
        ),
    );
}

访问器缓存

当从访问器返回值对象时，对值对象所做的任何更改都会在模型保存前自动同步回模型。这是可能的，因为 Eloquent 会保留访问器返回的实例，以便每次调用访问器时都能返回相同的实例：

php

use App\Models\User;

$user = User::find(1);

$user->address->lineOne = '更新后的地址行 1 值';
$user->address->lineTwo = '更新后的地址行 2 值';

$user->save();

但是，有时你可能希望对原始值（如字符串和布尔值）启用缓存，尤其是在计算密集型的情况下。为此，你可以在定义访问器时调用 shouldCache 方法：

php

protected function hash(): Attribute
{
    return Attribute::make(
        get: fn (string $value) => bcrypt(gzuncompress($value)),
    )->shouldCache();
}

如果你想禁用属性的对象缓存行为，可以在定义属性时调用 withoutObjectCaching 方法：

php

/**
 * 与用户的地址交互。
 */
protected function address(): Attribute
{
    return Attribute::make(
        get: fn (mixed $value, array $attributes) => new Address(
            $attributes['address_line_one'],
            $attributes['address_line_two'],
        ),
    )->withoutObjectCaching();
}

定义修改器

修改器在设置 Eloquent 属性值时对其进行转换。要定义修改器，你可以在定义属性时提供 set 参数。让我们为 first_name 属性定义一个修改器。当我们尝试在模型上设置 first_name 属性的值时，将自动调用此修改器：

php

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Casts\Attribute;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 与用户的名字交互。
     */
    protected function firstName(): Attribute
    {
        return Attribute::make(
            get: fn (string $value) => ucfirst($value),
            set: fn (string $value) => strtolower($value),
        );
    }
}

修改器闭包将接收正在设置的属性值，允许你操作该值并返回操作后的值。要使用我们的修改器，我们只需要在 Eloquent 模型上设置 first_name 属性：

php

use App\Models\User;

$user = User::find(1);

$user->first_name = 'Sally';

在此示例中，set 回调将使用值 Sally 调用。然后修改器将 strtolower 函数应用于该名称，并将其结果值设置到模型的内部 $attributes 数组中。

修改多个属性

有时你的修改器可能需要在底层模型上设置多个属性。为此，你可以从 set 闭包返回一个数组。数组中的每个键应对应于与模型关联的底层属性/数据库列：

php

use App\Support\Address;
use Illuminate\Database\Eloquent\Casts\Attribute;

/**
 * 与用户的地址交互。
 */
protected function address(): Attribute
{
    return Attribute::make(
        get: fn (mixed $value, array $attributes) => new Address(
            $attributes['address_line_one'],
            $attributes['address_line_two'],
        ),
        set: fn (Address $value) => [
            'address_line_one' => $value->lineOne,
            'address_line_two' => $value->lineTwo,
        ],
    );
}

属性类型转换

属性类型转换提供了类似于访问器和修改器的功能，但无需在模型上定义任何额外的方法。相反，模型的 casts 方法提供了一种将属性转换为常见数据类型的便捷方式。

casts 方法应返回一个数组，其中键是要转换的属性名称，值是希望将列转换成的类型。支持的转换类型有：

array
AsFluent::class
AsStringable::class
AsUri::class
boolean
collection
date
datetime
immutable_date
immutable_datetime
decimal:<precision>
double
encrypted
encrypted:array
encrypted:collection
encrypted:object
float
hashed
integer
object
real
string
timestamp

为了演示属性转换，让我们将 is_admin 属性（在数据库中存储为整数 0 或 1）转换为布尔值：

php

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 获取应被转换的属性。
     *
     * @return array<string, string>
     */
    protected function casts(): array
    {
        return [
            'is_admin' => 'boolean',
        ];
    }
}

定义转换后，当你访问 is_admin 属性时，它将始终被转换为布尔值，即使底层值在数据库中存储为整数：

php

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

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

如果你需要在运行时添加一个新的临时转换，可以使用 mergeCasts 方法。这些转换定义将添加到模型已有的任何转换中：

php

$user->mergeCasts([
    'is_admin' => 'integer',
    'options' => 'object',
]);

WARNING

值为 null 的属性将不会被转换。此外，你绝不应定义与关系同名的转换（或属性），也不应将转换分配给模型的主键。

Stringable 转换

你可以使用 Illuminate\Database\Eloquent\Casts\AsStringable 转换类将模型属性转换为流畅的 Illuminate\Support\Stringable 对象：

php

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Casts\AsStringable;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 获取应被转换的属性。
     *
     * @return array<string, string>
     */
    protected function casts(): array
    {
        return [
            'directory' => AsStringable::class,
        ];
    }
}

数组与 JSON 转换

在处理存储为序列化 JSON 的列时，array 转换特别有用。例如，如果您的数据库具有包含序列化 JSON 的 JSON 或 TEXT 字段类型，则向该属性添加 array 转换将在您访问 Eloquent 模型上的属性时自动将属性反序列化为 PHP 数组：

php

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 获取应被转换的属性。
     *
     * @return array<string, string>
     */
    protected function casts(): array
    {
        return [
            'options' => 'array',
        ];
    }
}

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

php

use App\Models\User;

$user = User::find(1);

$options = $user->options;

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

$user->options = $options;

$user->save();

要使用更简洁的语法更新 JSON 属性的单个字段，您可以使该属性可批量赋值，并在调用 update 方法时使用 -> 运算符：

php

$user = User::find(1);

$user->update(['options->key' => 'value']);

JSON 与 Unicode

如果您想将数组属性存储为 JSON 并保留 Unicode 字符而不转义，可以使用 json:unicode 转换：

php

/**
 * 获取应被转换的属性。
 *
 * @return array<string, string>
 */
protected function casts(): array
{
    return [
        'options' => 'json:unicode',
    ];
}

数组对象与集合转换

尽管标准的 array 转换对许多应用程序来说已经足够，但它确实有一些缺点。由于 array 转换返回一个原始类型，因此无法直接修改数组的偏移量。例如，以下代码将触发 PHP 错误：

php

$user = User::find(1);

$user->options['key'] = $value;

为了解决这个问题，Laravel 提供了一个 AsArrayObject 转换，它将您的 JSON 属性转换为 ArrayObject 类。此功能是使用 Laravel 的自定义转换实现实现的，它允许 Laravel 智能地缓存和转换修改后的对象，从而可以修改单个偏移量而不会触发 PHP 错误。要使用 AsArrayObject 转换，只需将其分配给一个属性：

php

use Illuminate\Database\Eloquent\Casts\AsArrayObject;

/**
 * 获取应被转换的属性。
 *
 * @return array<string, string>
 */
protected function casts(): array
{
    return [
        'options' => AsArrayObject::class,
    ];
}

同样，Laravel 提供了一个 AsCollection 转换，它将您的 JSON 属性转换为 Laravel 集合实例：

php

use Illuminate\Database\Eloquent\Casts\AsCollection;

/**
 * 获取应被转换的属性。
 *
 * @return array<string, string>
 */
protected function casts(): array
{
    return [
        'options' => AsCollection::class,
    ];
}

如果您希望 AsCollection 转换实例化一个自定义集合类而不是 Laravel 的基础集合类，您可以提供集合类名作为转换参数：

php

use App\Collections\OptionCollection;
use Illuminate\Database\Eloquent\Casts\AsCollection;

/**
 * 获取应被转换的属性。
 *
 * @return array<string, string>
 */
protected function casts(): array
{
    return [
        'options' => AsCollection::using(OptionCollection::class),
    ];
}

of 方法可用于指示集合项应通过集合的 mapInto 方法映射到给定类：

php

use App\ValueObjects\Option;
use Illuminate\Database\Eloquent\Casts\AsCollection;

/**
 * 获取应被转换的属性。
 *
 * @return array<string, string>
 */
protected function casts(): array
{
    return [
        'options' => AsCollection::of(Option::class)
    ];
}

将集合映射到对象时，对象应实现 Illuminate\Contracts\Support\Arrayable 和 JsonSerializable 接口，以定义其实例应如何序列化为 JSON 存储到数据库：

php

<?php

namespace App\ValueObjects;

use Illuminate\Contracts\Support\Arrayable;
use JsonSerializable;

class Option implements Arrayable, JsonSerializable
{
    public string $name;
    public mixed $value;
    public bool $isLocked;

    /**
     * 创建一个新的 Option 实例。
     */
    public function __construct(array $data)
    {
        $this->name = $data['name'];
        $this->value = $data['value'];
        $this->isLocked = $data['is_locked'];
    }

    /**
     * 获取实例的数组表示。
     *
     * @return array{name: string, data: string, is_locked: bool}
     */
    public function toArray(): array
    {
        return [
            'name' => $this->name,
            'value' => $this->value,
            'is_locked' => $this->isLocked,
        ];
    }

    /**
     * 指定应序列化为 JSON 的数据。
     *
     * @return array{name: string, data: string, is_locked: bool}
     */
    public function jsonSerialize(): array
    {
        return $this->toArray();
    }
}

二进制转换

如果您的 Eloquent 模型除了模型的自动递增 ID 列外，还有二进制类型的 uuid 或 ulid 列，您可以使用 AsBinary 转换自动将值转换为其二进制表示并恢复：

php

use Illuminate\Database\Eloquent\Casts\AsBinary;

/**
 * 获取应被转换的属性。
 *
 * @return array<string, string>
 */
protected function casts(): array
{
    return [
        'uuid' => AsBinary::uuid(),
        'ulid' => AsBinary::ulid(),
    ];
}

一旦在模型上定义了转换，您可以将 UUID / ULID 属性值设置为对象实例或字符串。Eloquent 将自动将该值转换为其二进制表示。在检索属性值时，您将始终获得一个纯文本字符串值：

php

use Illuminate\Support\Str;

$user->uuid = Str::uuid();

return $user->uuid;

// "6e8cdeed-2f32-40bd-b109-1e4405be2140"

日期转换

默认情况下，Eloquent 会将 created_at 和 updated_at 列转换为 Carbon 的实例，该类扩展了 PHP DateTime 类并提供了一系列有用的方法。您可以通过在模型的 casts 方法中定义额外的日期转换来转换其他日期属性。通常，应使用 datetime 或 immutable_datetime 转换类型来转换日期。

在定义 date 或 datetime 转换时，您还可以指定日期的格式。当模型被序列化为数组或 JSON 时，将使用此格式：

php

/**
 * 获取应被转换的属性。
 *
 * @return array<string, string>
 */
protected function casts(): array
{
    return [
        'created_at' => 'datetime:Y-m-d',
    ];
}

当一列被转换为日期时，您可以将相应的模型属性值设置为 UNIX 时间戳、日期字符串（Y-m-d）、日期时间字符串或 DateTime / Carbon 实例。日期的值将被正确转换并存储在您的数据库中。

您可以通过在模型上定义 serializeDate 方法来自定义所有模型日期的默认序列化格式。此方法不会影响您的日期在数据库中的存储格式：

php

/**
 * 为数组 / JSON 序列化准备日期。
 */
protected function serializeDate(DateTimeInterface $date): string
{
    return $date->format('Y-m-d');
}

要指定在数据库中实际存储模型日期时应使用的格式，您应该使用模型 Table 属性上的 dateFormat 参数：

php

use Illuminate\Database\Eloquent\Attributes\Table;

#[Table(dateFormat: 'U')]
class Flight extends Model
{
    // ...
}

日期转换、序列化和时区

默认情况下，date 和 datetime 转换会将日期序列化为 UTC ISO-8601 日期字符串（YYYY-MM-DDTHH:MM:SS.uuuuuuZ），无论应用程序的 timezone 配置选项中指定的时区是什么。强烈建议始终使用此序列化格式，并通过不将应用程序的 timezone 配置选项从其默认的 UTC 值更改，以 UTC 时区存储应用程序的日期。在整个应用程序中始终使用 UTC 时区将提供与用 PHP 和 JavaScript 编写的其他日期操作库的最大互操作性。

如果将自定义格式应用于 date 或 datetime 转换，例如 datetime:Y-m-d H:i:s，则在日期序列化期间将使用 Carbon 实例的内部时区。通常，这将是应用程序的 timezone 配置选项中指定的时区。但需要注意的是，诸如 created_at 和 updated_at 之类的 timestamp 列不受此行为的影响，它们始终以 UTC 格式进行格式化，无论应用程序的时区设置如何。

枚举转换

Eloquent 还允许您将属性值转换为 PHP 枚举。为此，您可以在模型的 casts 方法中指定要转换的属性和枚举：

php

use App\Enums\ServerStatus;

/**
 * 获取应被转换的属性。
 *
 * @return array<string, string>
 */
protected function casts(): array
{
    return [
        'status' => ServerStatus::class,
    ];
}

在模型上定义转换后，当您与该属性交互时，指定的属性将自动在枚举和原始值之间转换：

php

if ($server->status == ServerStatus::Provisioned) {
    $server->status = ServerStatus::Ready;

    $server->save();
}

转换枚举数组

有时您可能需要在单个列中存储枚举值数组。为此，您可以使用 Laravel 提供的 AsEnumArrayObject 或 AsEnumCollection 转换：

php

use App\Enums\ServerStatus;
use Illuminate\Database\Eloquent\Casts\AsEnumCollection;

/**
 * 获取应被转换的属性。
 *
 * @return array<string, string>
 */
protected function casts(): array
{
    return [
        'statuses' => AsEnumCollection::of(ServerStatus::class),
    ];
}

加密转换

encrypted 转换将使用 Laravel 内置的加密功能加密模型属性值。此外，encrypted:array、encrypted:collection、encrypted:object、AsEncryptedArrayObject 和 AsEncryptedCollection 转换的工作方式与其未加密的对应项类似；但是，如您所料，底层值在存储到数据库时会被加密。

由于加密文本的最终长度不可预测，并且比其纯文本对应物更长，请确保相关的数据库列为 TEXT 类型或更大。此外，由于值在数据库中是加密的，您将无法查询或搜索加密的属性值。

密钥轮换

如您所知，Laravel 使用应用程序的 app 配置文件中指定的 key 配置值加密字符串。通常，此值对应于 APP_KEY 环境变量的值。如果您需要轮换应用程序的加密密钥，您可以优雅地这样做。

查询时类型转换

有时您可能需要在执行查询时应用转换，例如从表中选择原始值时。例如，考虑以下查询：

php

use App\Models\Post;
use App\Models\User;

$users = User::select([
    'users.*',
    'last_posted_at' => Post::selectRaw('MAX(created_at)')
        ->whereColumn('user_id', 'users.id')
])->get();

此查询结果中的 last_posted_at 属性将是一个简单的字符串。如果我们在执行查询时能够对此属性应用 datetime 转换，那就太好了。幸运的是，我们可以使用 withCasts 方法来实现这一点：

php

$users = User::select([
    'users.*',
    'last_posted_at' => Post::selectRaw('MAX(created_at)')
        ->whereColumn('user_id', 'users.id')
])->withCasts([
    'last_posted_at' => 'datetime'
])->get();

自定义类型转换

Laravel 有多种内置的、有用的转换类型；但是，您有时可能需要定义自己的转换类型。要创建转换，请执行 make:cast Artisan 命令。新的转换类将放置在您的 app/Casts 目录中：

shell

php artisan make:cast AsJson

所有自定义转换类都实现了 CastsAttributes 接口。实现此接口的类必须定义 get 和 set 方法。get 方法负责将数据库中的原始值转换为转换后的值，而 set 方法应将转换后的值转换为可以存储在数据库中的原始值。作为示例，我们将内置的 json 转换类型重新实现为自定义转换类型：

php

<?php

namespace App\Casts;

use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Model;

class AsJson implements CastsAttributes
{
    /**
     * 转换给定的值。
     *
     * @param  array<string, mixed>  $attributes
     * @return array<string, mixed>
     */
    public function get(
        Model $model,
        string $key,
        mixed $value,
        array $attributes,
    ): array {
        return json_decode($value, true);
    }

    /**
     * 为存储准备给定的值。
     *
     * @param  array<string, mixed>  $attributes
     */
    public function set(
        Model $model,
        string $key,
        mixed $value,
        array $attributes,
    ): string {
        return json_encode($value);
    }
}

一旦您定义了自定义转换类型，您可以使用其类名将其附加到模型属性：

php

<?php

namespace App\Models;

use App\Casts\AsJson;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    /**
     * 获取应被转换的属性。
     *
     * @return array<string, string>
     */
    protected function casts(): array
    {
        return [
            'options' => AsJson::class,
        ];
    }
}

值对象转换

您不限于将值转换为原始类型。您还可以将值转换为对象。定义将值转换为对象的自定义转换与转换为原始类型非常相似；但是，如果您的值对象包含多个数据库列，则 set 方法必须返回一个键/值对数组，这些键/值对将用于在模型上设置原始的、可存储的值。如果您的值对象只影响单个列，您应该只返回可存储的值。

例如，我们将定义一个自定义转换类，将多个模型值转换为单个 Address 值对象。我们假设 Address 值对象有两个公共属性：lineOne 和 lineTwo：

php

<?php

namespace App\Casts;

use App\ValueObjects\Address;
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;
use Illuminate\Database\Eloquent\Model;
use InvalidArgumentException;

class AsAddress implements CastsAttributes
{
    /**
     * 转换给定的值。
     *
     * @param  array<string, mixed>  $attributes
     */
    public function get(
        Model $model,
        string $key,
        mixed $value,
        array $attributes,
    ): Address {
        return new Address(
            $attributes['address_line_one'],
            $attributes['address_line_two']
        );
    }

    /**
     * 为存储准备给定的值。
     *
     * @param  array<string, mixed>  $attributes
     * @return array<string, string>
     */
    public function set(
        Model $model,
        string $key,
        mixed $value,
        array $attributes,
    ): array {
        if (! $value instanceof Address) {
            throw new InvalidArgumentException('The given value is not an Address instance.');
        }

        return [
            'address_line_one' => $value->lineOne,
            'address_line_two' => $value->lineTwo,
        ];
    }
}

当转换为值对象时，对值对象所做的任何更改都会在模型保存前自动同步回模型：

php

use App\Models\User;

$user = User::find(1);

$user->address->lineOne = '更新后的地址值';

$user->save();

NOTE

如果您计划将包含值对象的 Eloquent 模型序列化为 JSON 或数组，您应该在值对象上实现 Illuminate\Contracts\Support\Arrayable 和 JsonSerializable 接口。

值对象缓存

当解析转换为值对象的属性时，它们会被 Eloquent 缓存。因此，如果再次访问该属性，将返回相同的对象实例。

如果您想禁用自定义转换类的对象缓存行为，您可以在自定义转换类上声明一个公共的 withoutObjectCaching 属性：

php

class AsAddress implements CastsAttributes
{
    public bool $withoutObjectCaching = true;

    // ...
}

数组 / JSON 序列化

当使用 toArray 和 toJson 方法将 Eloquent 模型转换为数组或 JSON 时，只要您的自定义转换值对象实现了 Illuminate\Contracts\Support\Arrayable 和 JsonSerializable 接口，它们通常也会被序列化。但是，当使用第三方库提供的值对象时，您可能无法向该对象添加这些接口。

因此，您可以指定您的自定义转换类负责序列化值对象。为此，您的自定义转换类应实现 Illuminate\Contracts\Database\Eloquent\SerializesCastableAttributes 接口。该接口规定您的类应包含一个 serialize 方法，该方法应返回您的值对象的序列化形式：

php

/**
 * 获取值的序列化表示。
 *
 * @param  array<string, mixed>  $attributes
 */
public function serialize(
    Model $model,
    string $key,
    mixed $value,
    array $attributes,
): string {
    return (string) $value;
}

入站转换

有时，您可能需要编写一个自定义转换类，该类仅转换正在模型上设置的值，并且在从模型检索属性时不执行任何操作。

仅入站的自定义转换应实现 CastsInboundAttributes 接口，该接口只需要定义 set 方法。make:cast Artisan 命令可以使用 --inbound 选项调用，以生成一个仅入站的转换类：

shell

php artisan make:cast AsHash --inbound

仅入站转换的一个典型示例是“哈希”转换。例如，我们可以定义一个转换，通过给定的算法对入站值进行哈希处理：

php

<?php

namespace App\Casts;

use Illuminate\Contracts\Database\Eloquent\CastsInboundAttributes;
use Illuminate\Database\Eloquent\Model;

class AsHash implements CastsInboundAttributes
{
    /**
     * 创建一个新的转换类实例。
     */
    public function __construct(
        protected string|null $algorithm = null,
    ) {}

    /**
     * 为存储准备给定的值。
     *
     * @param  array<string, mixed>  $attributes
     */
    public function set(
        Model $model,
        string $key,
        mixed $value,
        array $attributes,
    ): string {
        return is_null($this->algorithm)
            ? bcrypt($value)
            : hash($this->algorithm, $value);
    }
}

转换参数

将自定义转换附加到模型时，可以通过使用 : 字符将参数与类名分隔开，并使用逗号分隔多个参数来指定转换参数。这些参数将被传递给转换类的构造函数：

php

/**
 * 获取应被转换的属性。
 *
 * @return array<string, string>
 */
protected function casts(): array
{
    return [
        'secret' => AsHash::class.':sha256',
    ];
}

比较转换值

如果您想定义应如何比较两个给定的转换值以确定它们是否已更改，您的自定义转换类可以实现 Illuminate\Contracts\Database\Eloquent\ComparesCastableAttributes 接口。这使您可以精细控制哪些值被 Eloquent 视为已更改，从而在模型更新时保存到数据库。

该接口规定您的类应包含一个 compare 方法，如果给定的值被认为相等，则该方法应返回 true：

php

/**
 * 确定给定的值是否相等。
 *
 * @param  \Illuminate\Database\Eloquent\Model  $model
 * @param  string  $key
 * @param  mixed  $firstValue
 * @param  mixed  $secondValue
 * @return bool
 */
public function compare(
    Model $model,
    string $key,
    mixed $firstValue,
    mixed $secondValue
): bool {
    return $firstValue === $secondValue;
}

可转换类

您可能希望允许应用程序的值对象定义自己的自定义转换类。您可以将值对象类附加到模型上，而不是将自定义转换类附加到模型上，该值对象类实现了 Illuminate\Contracts\Database\Eloquent\Castable 接口：

php

use App\ValueObjects\Address;

protected function casts(): array
{
    return [
        'address' => Address::class,
    ];
}

实现 Castable 接口的对象必须定义一个 castUsing 方法，该方法返回负责与 Castable 类之间进行转换的自定义转换器类的类名：

php

<?php

namespace App\ValueObjects;

use Illuminate\Contracts\Database\Eloquent\Castable;
use App\Casts\AsAddress;

class Address implements Castable
{
    /**
     * 获取用于与此转换目标之间进行转换的转换器类的名称。
     *
     * @param  array<string, mixed>  $arguments
     */
    public static function castUsing(array $arguments): string
    {
        return AsAddress::class;
    }
}

当使用 Castable 类时，您仍然可以在 casts 方法定义中提供参数。这些参数将被传递给 castUsing 方法：

php

use App\ValueObjects\Address;

protected function casts(): array
{
    return [
        'address' => Address::class.':argument',
    ];
}

可转换类与匿名转换类

通过将“可转换类”与 PHP 的匿名类结合使用，您可以将值对象及其转换逻辑定义为一个单一的可转换对象。为此，请从您的值对象的 castUsing 方法返回一个匿名类。匿名类应实现 CastsAttributes 接口：

php

<?php

namespace App\ValueObjects;

use Illuminate\Contracts\Database\Eloquent\Castable;
use Illuminate\Contracts\Database\Eloquent\CastsAttributes;

class Address implements Castable
{
    // ...

    /**
     * 获取用于与此转换目标之间进行转换的转换器类。
     *
     * @param  array<string, mixed>  $arguments
     */
    public static function castUsing(array $arguments): CastsAttributes
    {
        return new class implements CastsAttributes
        {
            public function get(
                Model $model,
                string $key,
                mixed $value,
                array $attributes,
            ): Address {
                return new Address(
                    $attributes['address_line_one'],
                    $attributes['address_line_two']
                );
            }

            public function set(
                Model $model,
                string $key,
                mixed $value,
                array $attributes,
            ): array {
                return [
                    'address_line_one' => $value->lineOne,
                    'address_line_two' => $value->lineTwo,
                ];
            }
        };
    }
}

Eloquent：修改器 & 类型转换 ​

简介 ​

访问器与修改器 ​

定义访问器 ​

从多个属性构建值对象 ​

访问器缓存 ​

定义修改器 ​

修改多个属性 ​

属性类型转换 ​

Stringable 转换 ​

数组与 JSON 转换 ​

JSON 与 Unicode ​

数组对象与集合转换 ​

二进制转换 ​

日期转换 ​

日期转换、序列化和时区 ​

枚举转换 ​

转换枚举数组 ​

加密转换 ​

密钥轮换 ​

查询时类型转换 ​

自定义类型转换 ​

值对象转换 ​

值对象缓存 ​

数组 / JSON 序列化 ​

入站转换 ​

转换参数 ​

比较转换值 ​

可转换类 ​

可转换类与匿名转换类 ​