类 ArrayContext
为 FormHelper 提供基本的基于数组的上下文提供者。
此适配器在测试或表单由简单的数组数据结构支持时很有用。
重要键
data存储为字段提供的当前值。defaults字段的默认值。当没有设置数据时，将使用这些值。数据应按照您使用点分隔路径访问字段的方式进行嵌套。required字段、关系和布尔标志的嵌套数组，用于指示字段是否必填。该值也可以是字符串，用作必填错误消息。schema一组模拟 {@link \Cake\Database\Schema\TableSchema} 使用的列结构的数据。此数组允许您控制字段的推断类型，并允许自动生成诸如 maxlength、step 和其他 HTML 属性之类的属性。如果您希望主键/ID 检测正常工作。确保您提供了一个包含primary的_constraints数组。请参阅下面的示例。errors验证错误的数组。错误应按照您使用点分隔路径访问字段的方式进行嵌套。
示例
$article = [
'data' => [
'id' => '1',
'title' => 'First post!',
],
'schema' => [
'id' => ['type' => 'integer'],
'title' => ['type' => 'string', 'length' => 255],
'_constraints' => [
'primary' => ['type' => 'primary', 'columns' => ['id']]
]
],
'defaults' => [
'title' => 'Default title',
],
'required' => [
'id' => true, // will use default required message
'title' => 'Please enter a title',
'body' => false,
],
];
命名空间： Cake\View\Form
常量
-
list<string>VALID_ATTRIBUTES ¶['length', 'precision', 'comment', 'null', 'default']
属性摘要
-
$_context protected
array<string, mixed>此对象的上下文数据。
方法摘要
-
__construct() public
构造函数。
-
attributes() public
获取字段名称的其他属性的关联数组。
-
error() public
获取给定字段的错误。
-
fieldNames() public
获取此上下文中的顶级对象的字段名称。
-
getMaxLength() public
从验证中获取字段长度。
-
getPrimaryKey() public
获取用作此上下文主键的字段。
-
getRequiredMessage() public
获取字段的默认“必填”错误消息。
-
hasError() public
检查字段是否附加了错误。
-
isCreate() public
返回此表单是否用于创建操作。
-
isPrimaryKey() public
如果传递的字段名称是此上下文的primaryKey的一部分，则返回true。
-
isRequired() public
检查给定字段是否“必填”。
-
stripNesting() protected
剥离任何数字嵌套。
-
type() public
获取给定字段名称的抽象字段类型。
-
val() public
获取给定字段的当前值。
方法详情
attributes() ¶ public
attributes(string $field): array获取字段名称的其他属性的关联数组。
参数
-
string$field 点分隔路径，用于获取其他数据。
返回
arraygetMaxLength() ¶ public
getMaxLength(string $field): int|null从验证中获取字段长度。
在此上下文类中，这由“长度”数组简单定义。
参数
-
string$field 点分隔路径，用于检查必填项。
返回
int|nullgetRequiredMessage() ¶ public
getRequiredMessage(string $field): string|null获取字段的默认“必填”错误消息。
参数
-
string$field
返回
string|nullhasError() ¶ public
hasError(string $field): bool检查字段是否附加了错误。
参数
-
string$field 点分隔路径，用于检查错误。
返回
boolisCreate() ¶ public
isCreate(): bool返回此表单是否用于创建操作。
为了使此方法返回 true，主键约束必须在“schema”数据中定义，并且“defaults”数据必须包含该键中所有字段的值。
返回
boolisPrimaryKey() ¶ public
isPrimaryKey(string $field): bool如果传递的字段名称是此上下文的primaryKey的一部分，则返回true。
参数
-
string$field
返回
boolisRequired() ¶ public
isRequired(string $field): bool|null检查给定字段是否“必填”。
在此上下文类中，这由“required”数组简单定义。
参数
-
string$field 点分隔路径，用于检查必填项。
返回
bool|nullstripNesting() ¶ protected
stripNesting(string $field): string剥离任何数字嵌套。
例如 users.0.age 将输出为 users.age
参数
-
string$field 点分隔路径
返回
stringtype() ¶ public
type(string $field): string|null获取给定字段名称的抽象字段类型。
参数
-
string$field 点分隔路径，用于获取架构类型。
返回
string|null另请参阅
\Cake\Database\TypeFactory
val() ¶ public
val(string $field, array<string, mixed> $options = []): mixed获取给定字段的当前值。
此方法将合并当前数据和“defaults”数组。
参数
-
string$field 点分隔路径，指向需要值的字段。
-
array<string, mixed>$options optional 选项
返回
mixed