DateTimeWidget 类
用于生成日期时间输入小部件的输入小部件类。
此类通常由 Cake\View\Helper\FormHelper
内部使用,但可以用于生成独立的日期时间输入。
命名空间: Cake\View\Widget
属性摘要
-
$_templates protected
Cake\View\StringTemplate
模板实例。
-
$defaultStep protected
array<string, mixed>
各种输入类型的步长大小。
-
$defaults protected
array<string, mixed>
数据默认值。
-
$formatMap protected
array<string, string>
各种输入类型的格式。
方法摘要
-
__construct() public
构造函数。
-
formatDateTime() 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 模板列表。
formatDateTime() ¶ protected
formatDateTime(Cake\Chronos\ChronosDateCake\Chronos\ChronosTimeDateTimeInterface|string|int|null $value, array<string, mixed> $options): string
将传入的日期/时间值格式化为所需的字符串格式。
参数
-
Cake\Chronos\ChronosDateCake\Chronos\ChronosTimeDateTimeInterface|string|int|null
$value 要分解的值。
-
array<string, mixed>
$options 转换选项。
返回
string
抛出
InvalidArgumentException
如果传入无效的输入类型。
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
名称属性。val
值属性。escape
设置为 false 以禁用所有属性的转义。type
有效的 HTML 日期/时间输入类型。默认为“datetime-local”。timezone
输入值应转换为的时区。step
“step” 属性。对于“time”和“datetime-local”类型的输入,默认为1
。您可以将其设置为null
或false
以防止在 HTML 中添加显式的 step 属性。format
与date()
函数兼容的日期时间格式字符串。默认情况下,小部件将根据上下文中的输入类型和数据库类型使用合适的格式。如果提供了显式格式,则不会为step
属性设置默认值,如果需要,则需要显式设置。
所有其他键都将转换为 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>