类 FormContext
为 {@link \Cake\Form\Form} 实例提供上下文提供者。
此上下文提供者仅满足 FormHelper 的接口要求,并允许访问表单数据。
命名空间: Cake\View\Form
常量
-
list<string>
VALID_ATTRIBUTES ¶['length', 'precision', 'comment', 'null', 'default']
属性摘要
-
$_form protected
Cake\Form\Form
表单对象。
-
$_validator protected
string|null
验证器名称。
方法摘要
-
__construct() public
构造函数。
-
_schemaDefault() protected
获取给定字段的表单模式的默认值。
-
attributes() public
获取给定字段名称的其他属性的关联数组。
-
error() public
获取给定字段的错误。
-
fieldNames() public
获取此上下文中的顶级对象的字段名称。
-
getMaxLength() public
从模型验证中获取字段的最大长度。
-
getPrimaryKey() public
获取此上下文用作主键的字段。
-
getRequiredMessage() public
获取字段的默认“required”错误消息
-
hasError() public
检查字段是否附加了错误
-
isCreate() public
返回此表单是否用于创建操作。
-
isPrimaryKey() public
如果传递的字段名称是此上下文的“主键”的一部分,则返回 true
-
isRequired() public
检查给定字段是否为“required”。
-
type() public
获取给定字段名称的抽象字段类型。
-
val() public
获取给定字段的当前值。
方法详情
_schemaDefault() ¶ protected
_schemaDefault(string $field): mixed
获取给定字段的表单模式的默认值。
参数
-
string
$field 字段名称。
返回
mixed
attributes() ¶ public
attributes(string $field): array
获取给定字段名称的其他属性的关联数组。
参数
-
string
$field
返回
array
getMaxLength() ¶ public
getMaxLength(string $field): int|null
从模型验证中获取字段的最大长度。
参数
-
string
$field
返回
int|null
getRequiredMessage() ¶ public
getRequiredMessage(string $field): string|null
获取字段的默认“required”错误消息
参数
-
string
$field
返回
string|null
isPrimaryKey() ¶ public
isPrimaryKey(string $field): bool
如果传递的字段名称是此上下文的“主键”的一部分,则返回 true
参数
-
string
$field
返回
bool
isRequired() ¶ public
isRequired(string $field): bool|null
检查给定字段是否为“required”。
在此上下文类中,这仅由“required”数组定义。
参数
-
string
$field
返回
bool|null
val() ¶ public
val(string $field, array<string, mixed> $options = []): mixed
获取给定字段的当前值。
实现此方法的类可以选择具有第二个参数 $options
。$options
数组的有效键为
default
: 如果在数据或上下文记录中找不到值,则返回的默认值。schemaDefault
: 布尔值,指示如果上下文模式中未明确提供默认值,是否应使用默认值。
参数
-
string
$field -
array<string, mixed>
$options optional
返回
mixed