复选框小部件类
用于创建复选框小部件的输入小部件。
此类通常由 Cake\View\Helper\FormHelper
内部使用,但可以用于生成独立的复选框。
命名空间: Cake\View\Widget
属性概述
-
$_templates protected
Cake\View\StringTemplate
字符串模板实例。
-
$defaults protected
array<string, mixed>
数据默认值。
方法概述
-
__construct() public
构造函数。
-
_isChecked() protected
检查复选框是否应该被选中。
-
mergeDefaults() protected
将默认值与提供的數據合併。
-
render() public
渲染复选框元素。
-
secureFields() public
返回需要为该小部件保护的字段列表。
-
setMaxLength() protected
如果适用,设置 "maxlength" 属性的值。
-
setRequired() protected
如果适用,设置 "required" 属性的值。
-
setStep() protected
如果适用,设置 "step" 属性的值。
方法详细
__construct() ¶ public
__construct(Cake\View\StringTemplate $templates)
构造函数。
参数
-
Cake\View\StringTemplate
$templates 模板列表。
_isChecked() ¶ protected
_isChecked(array<string, mixed> $data): bool
检查复选框是否应该被选中。
参数
-
array<string, mixed>
$data 要查看并确定选中状态的数据。
返回
bool
mergeDefaults() ¶ protected
mergeDefaults(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): array<string, mixed>
将默认值与提供的數據合併。
参数
-
array<string, mixed>
$data 数据数组
-
Cake\View\Form\ContextInterface
$context 上下文实例。
返回
array<string, mixed>
render() ¶ public
render(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): string
渲染复选框元素。
数据支持以下键
name
- 输入的名称。value
- value 属性。默认值为 '1'。val
- 当前值。如果它与value
相匹配,则复选框将被选中。您也可以使用 'checked' 属性来使复选框被选中。disabled
- 复选框是否应该被禁用。
传入的任何其他属性都将被视为 HTML 属性。
参数
-
array<string, mixed>
$data 用于创建复选框的数据。
-
Cake\View\Form\ContextInterface
$context 当前表单上下文。
返回
string
secureFields() ¶ public
secureFields(array<string, mixed> $data): list<string>
返回需要为该小部件保护的字段列表。
参数
-
array<string, mixed>
$data
返回
list<string>
setMaxLength() ¶ protected
setMaxLength(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>
如果适用,设置 "maxlength" 属性的值。
参数
-
array<string, mixed>
$data 数据数组
-
Cake\View\Form\ContextInterface
$context 上下文实例。
-
string
$fieldName 字段名称。
返回
array<string, mixed>
setRequired() ¶ protected
setRequired(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>
如果适用,设置 "required" 属性的值。
参数
-
array<string, mixed>
$data 数据数组
-
Cake\View\Form\ContextInterface
$context 上下文实例。
-
string
$fieldName 字段名称。
返回
array<string, mixed>
setStep() ¶ protected
setStep(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>
如果适用,设置 "step" 属性的值。
参数
-
array<string, mixed>
$data 数据数组
-
Cake\View\Form\ContextInterface
$context 上下文实例。
-
string
$fieldName 字段名称。
返回
array<string, mixed>