类 FailedJob

使用数组中的键初始化此实体的内部属性。可以使用以下选项列表

• useSetters：是否使用内部setter设置属性。
• markClean：是否在设置后将所有属性标记为干净。
• markNew：此实例是否尚未持久化。
• guard：是否阻止设置不可访问的属性（默认值：false）。
• source：一个字符串，表示此实体来自的存储库的别名。

示例

 $entity = new Entity(['id' => 1, 'name' => 'Andrew'])

参数

返回一个数组，该数组可用于描述此对象的内部状态。

返回值

Magic getter，用于访问已在此实体中设置的字段

参数

返回值

返回此实体是否包含名为 $field 的字段，且未设置为 null。

参数

返回值

Magic setter，用于添加或编辑此实体中的字段

参数

返回值

以人类可读的格式返回此对象的字符串表示形式。

返回值

从此实体中删除字段

参数

返回值

获取访问器方法名称访问器方法（可用与否）缓存在 $_accessors 中

参数

返回值

返回值

另请参阅

用于获取嵌套实体中错误的辅助方法

参数

返回值

从一个或多个对象中读取错误。

参数

返回值

读取一个或多个对象是否有错误。

参数

返回值

将整个实体设置为干净，这意味着它将显示为没有任何字段被修改或添加。对于初始对象填充，这是一个有用的调用

返回值

返回一个包含存储在此实体中的请求字段的数组，按字段名称索引

参数

返回值

返回一个包含存储在此实体中的请求原始字段的数组，按字段名称索引（如果存在）。

与原始值未更改的字段将包含在此方法的返回值中。

参数

返回值

仅返回一个包含存储在此实体中的原始字段的数组，按字段名称索引（如果存在）。

此方法仅返回自实体构建以来已修改的字段。未更改的字段将被省略。

参数

返回值

按名称返回字段的值

参数

返回值

抛出

返回此实体的原始可访问配置。* 通配符指的是所有字段。

返回值

获取脏字段。

返回值

返回字段的验证错误

参数

返回值

返回所有验证错误。

返回值

获取隐藏字段。

返回值

获取无效字段及其数据列表，用于验证/修补时的错误

返回值

获取单个无效字段的值。如果未设置，则返回 null。

参数

返回值

按名称返回原始字段的值

参数

返回值

抛出

返回一个包含原始字段的数组。原始字段是实体初始化时的那些字段。

返回值

获取实体的所有原始值。

返回值

返回此实体来自的存储库的别名。

返回值

获取此实体上的虚拟字段。

返回值

获取可见字段列表。

可见字段列表是所有标准字段加上虚拟字段减去隐藏字段。

返回值

返回此实体是否包含名为 $field 的字段。

即使对于设置为null 的字段，它也会返回true。

示例

$entity = new Entity(['id' => 1, 'name' => null]);
$entity->has('id'); // true
$entity->has('name'); // true
$entity->has('last_name'); // false

您可以通过传递数组来检查多个字段。

$entity->has(['name', 'last_name']);

当检查多个字段时，所有字段都必须具有值（即使是null）才能使方法返回true。

参数

返回值

返回此实体是否有错误。

参数

返回值

返回字段是否具有原始值

参数

返回值

检查字段是否具有值。

此方法将对以下内容返回 true：

• 非空字符串
• 非空数组
• 任何对象
• 整数，即使是0。
• 浮点数，即使是 0.0。

在所有其他情况下为 false。

参数

返回值

检查字段是否可访问

示例

$entity->isAccessible('id'); // Returns whether it can be set or not

参数

返回值

检查实体是否已脏或其单个字段是否已脏。

参数

返回值

检查字段是否为空

这不像 PHP empty() 函数那样工作。对于以下内容，该方法将返回 true：

• ''（空字符串）
• null
• []

在所有其他情况下为 false。

参数

返回值

返回此实体是否已持久化。

返回值

返回字段是否为原始字段

参数

返回值

返回将被序列化为 JSON 的字段

返回值

实现 isset($entity);

参数

返回值

实现 $entity[$offset];

参数

返回值

实现 $entity[$offset] = $value;

参数

返回值

实现 unset($result[$offset]);

参数

返回值

访问属性时启用/禁用字段存在检查。

如果启用，尝试访问不存在的属性时将引发异常。

参数

返回值

设置此实体内的单个字段。

示例

$entity->set('name', 'Andrew');

也可以通过将字段传递为字段 => 值对的哈希数组，一次性调用将多个字段批量分配给此实体。

示例

$entity->set(['name' => 'andrew', 'id' => 1]);
echo $entity->name // prints andrew
echo $entity->id // prints 1

有时在分配字段时，绕过此实体中的setter函数非常方便。您可以通过使用$options参数禁用setter选项来实现这一点。

$entity->set('name', 'Andrew', ['setter' => false]);
$entity->set(['name' => 'Andrew', 'id' => 1], ['setter' => false]);

在接受用户输入时，应谨慎对待批量赋值。默认情况下，实体会在批量赋值字段时保护所有字段。可以使用guard选项禁用单个设置调用的保护。

$entity->set(['name' => 'Andrew', 'id' => 1], ['guard' => false]);

单独赋值字段时，不需要使用guard选项。

// No need to use the guard option.
$entity->set('name', 'Andrew');

可以使用asOriginal选项将给定字段设置为原始字段，如果该字段在实体实例化时不存在。

$entity = new Entity(['name' => 'andrew', 'id' => 1]);

$entity->set('phone_number', '555-0134');
print_r($entity->getOriginalFields()) // prints ['name', 'id']

$entity->set('phone_number', '555-0134', ['asOriginal' => true]);
print_r($entity->getOriginalFields()) // prints ['name', 'id', 'phone_number']

参数

返回值

抛出

存储字段值是否可以在此实体中更改或设置。特殊字段*也可以标记为可访问或受保护，这意味着之前指定的任何其他字段将采用其值。例如$entity->setAccess('*', true)表示默认情况下，任何未指定字段都将可访问。

也可以使用字段数组调用此方法，在这种情况下，每个字段都将采用第二个参数中指定的访问权限值。

示例

$entity->setAccess('id', true); // Mark id as not protected
$entity->setAccess('author_id', false); // Mark author_id as protected
$entity->setAccess(['id', 'user_id'], true); // Mark both fields as accessible
$entity->setAccess('*', false); // Mark all fields as protected

参数

返回值

设置单个字段的脏状态。

参数

返回值

设置单个字段的错误。

示例

// Sets the error messages for a single field
$entity->setError('salary', ['must be numeric', 'must be a positive number']);

参数

返回值

设置实体的错误消息。

示例

// Sets the error messages for multiple fields at once
$entity->setErrors(['salary' => ['message'], 'name' => ['another message']]);

参数

返回值

设置隐藏字段。

参数

返回值

将字段设置为无效，不可修补到实体中。

这在需要在修补后获取错误消息的原始值的批量操作中很有用。此值无法修补到实体中，而是简单地复制到 _invalid 属性中，以供调试或将其记录下来。

参数

返回值

将字段设置为无效，不可修补到实体中。

参数

返回值

设置此实体的状态。

使用true表示实体尚未持久保存到数据库中，false表示实体已持久保存到数据库中。

参数

返回值

将给定字段或字段列表设置为原始。通常不需要手动调用此方法。

参数

返回值

设置源别名。

参数

返回值

设置此实体上的虚拟字段。

参数

返回值

返回一个包含已设置为此实体的所有字段的数组。

此方法将递归地将分配给字段的实体也转换为数组。

返回值

从此实体中删除字段或字段列表。

示例

$entity->unset('name');
$entity->unset(['name', 'last_name']);

参数

返回值