接口 ContextInterface
FormHelper 上下文实现的接口。
命名空间: Cake\View\Form
常量
-
list<string>
VALID_ATTRIBUTES ¶['length', 'precision', 'comment', 'null', 'default']
方法摘要
-
attributes() public
获取字段名称的其他属性的关联数组。
-
error() public
获取给定字段的错误信息。
-
fieldNames() public
获取此上下文中顶层对象的字段名称。
-
getMaxLength() public
从模型验证中获取字段的最大长度。
-
getPrimaryKey() public
获取用作此上下文中的主键的字段。
-
getRequiredMessage() public
获取字段的默认“必填”错误信息。
-
hasError() public
检查字段是否附加了错误信息。
-
isCreate() public
返回此表单是否用于创建操作。
-
isPrimaryKey() public
如果传递的字段名称是此上下文的 主键的一部分,则返回 true。
-
isRequired() public
检查给定字段是否为“必填”。
-
type() public
获取给定字段名称的抽象字段类型。
-
val() public
获取给定字段的当前值。
方法详情
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
获取字段的默认“必填”错误信息。
参数
-
string
$field 字段名称的点分隔路径。
返回值
string|null
hasError() ¶ public
hasError(string $field): bool
检查字段是否附加了错误信息。
参数
-
string
$field 检查错误信息的点分隔路径。
返回值
bool
isPrimaryKey() ¶ public
isPrimaryKey(string $field): bool
如果传递的字段名称是此上下文的 主键的一部分,则返回 true。
参数
-
string
$field 需要值的字段的点分隔路径。
返回值
bool
isRequired() ¶ public
isRequired(string $field): bool|null
检查给定字段是否为“必填”。
在此上下文类中,这仅由 'required' 数组定义。
参数
-
string
$field 检查必填性的点分隔路径。
返回值
bool|null
type() ¶ public
type(string $field): string|null
获取给定字段名称的抽象字段类型。
参数
-
string
$field 获取架构类型的点分隔路径。
返回值
string|null
参见
\Cake\Database\TypeFactory
val() ¶ public
val(string $field, array<string, mixed> $options = []): mixed
获取给定字段的当前值。
实现此方法的类可以选择具有第二个参数 $options
。$options
数组的有效键为
default
:如果在数据或上下文记录中找不到值,则返回的默认值。schemaDefault
:布尔值,指示是否应使用上下文架构中的默认值(如果未明确提供)。
参数
-
string
$field 需要值的字段的点分隔路径。
-
array<string, mixed>
$options optional 选项。
返回值
mixed