类 ValidationSet
ValidationSet 对象。持有字段的所有验证规则,并公开方法以动态添加或删除验证规则
命名空间: Cake\Validation
属性摘要
-
$_allowEmpty protected
callable|string|bool
表示字段是否允许为空
-
$_rules protected
arrayCake\Validation\ValidationRule>
保存 ValidationRule 对象
-
$_validatePresent protected
callable|string|bool
表示字段名键是否必须存在于数据数组中
方法摘要
-
add() public
使用 $name 设置 ValidationRule $rule
-
allowEmpty() public
设置字段值是否允许为空。
-
count() public
返回此集中规则的数量
-
getIterator() public
返回每个要应用的规则的迭代器
-
isEmptyAllowed() public
返回字段是否可以为空。
-
isPresenceRequired() public
返回字段是否可以省略。
-
offsetExists() public
返回规则集中是否存在索引
-
offsetGet() public
按其索引返回规则对象
-
offsetSet() public
设置或替换验证规则
-
offsetUnset() public
取消设置验证规则
-
remove() public
从集中删除验证规则
-
requirePresence() public
设置字段是否需要存在于数据数组中。
-
rule() public
如果存在,获取给定名称的规则
-
rules() public
返回此验证集的所有规则
方法详情
add() ¶ public
add(string $name, Cake\Validation\ValidationRule|array $rule): $this
使用 $name 设置 ValidationRule $rule
示例
$set
->add('notBlank', ['rule' => 'notBlank'])
->add('inRange', ['rule' => ['between', 4, 10])
参数
-
string
$name 应该设置规则的名称
-
Cake\Validation\ValidationRule|array
$rule 要设置的验证规则
返回值
$this
allowEmpty() ¶ public
allowEmpty(callable|string|bool $allowEmpty): $this
设置字段值是否允许为空。
参数
-
callable|string|bool
$allowEmpty 有效值为 true、false、'create'、'update' 或可调用对象。
返回值
$this
getIterator() ¶ public
getIterator(): Traversable<string,Cake\Validation\ValidationRule>
返回每个要应用的规则的迭代器
返回值
Traversable<string,Cake\Validation\ValidationRule>
isEmptyAllowed() ¶ public
isEmptyAllowed(): callable|string|bool
返回字段是否可以为空。
返回值
callable|string|bool
isPresenceRequired() ¶ public
isPresenceRequired(): callable|string|bool
返回字段是否可以省略。
返回值
callable|string|bool
offsetExists() ¶ public
offsetExists(string $index): bool
返回规则集中是否存在索引
参数
-
string
$index 规则的名称
返回值
bool
offsetGet() ¶ public
offsetGet(string $index): Cake\Validation\ValidationRule
按其索引返回规则对象
参数
-
string
$index 规则的名称
返回值
Cake\Validation\ValidationRule
offsetSet() ¶ public
offsetSet(string $offset, Cake\Validation\ValidationRule|array $value): void
设置或替换验证规则
参数
-
string
$offset 规则的名称
-
Cake\Validation\ValidationRule|array
$value 要添加到 $index 的规则
返回值
void
remove() ¶ public
remove(string $name): $this
从集中删除验证规则
示例
$set
->remove('notBlank')
->remove('inRange')
参数
-
string
$name 应该取消设置规则的名称
返回值
$this
requirePresence() ¶ public
requirePresence(callable|string|bool $validatePresent): $this
设置字段是否需要存在于数据数组中。
参数
-
callable|string|bool
$validatePresent 有效值为 true、false、'create'、'update' 或可调用对象。
返回值
$this
rule() ¶ public
rule(string $name): Cake\Validation\ValidationRule|null
如果存在,获取给定名称的规则
参数
-
string
$name 设置规则的名称。
返回值
Cake\Validation\ValidationRule|null
rules() ¶ public
rules(): arrayCake\Validation\ValidationRule>
返回此验证集的所有规则
返回值
arrayCake\Validation\ValidationRule>