Class YearWidget
Input widget class for generating a calendar year select box.
This class is usually used internally by Cake\View\Helper\FormHelper,
it but can be used to generate standalone calendar year select boxes.
Property Summary
-
$_select protected
Cake\View\Widget\SelectBoxWidgetSelect box widget.
-
$_templates protected
Cake\View\StringTemplateStringTemplate instance.
-
$defaults protected
array<string, mixed>Data defaults.
Method Summary
-
__construct() public
Constructor
-
mergeDefaults() protected
Merge default values with supplied data.
-
render() public
Renders a year select box.
-
secureFields() public
Returns a list of fields that need to be secured for this widget.
-
setMaxLength() protected
Set value for "maxlength" attribute if applicable.
-
setRequired() protected
Set value for "required" attribute if applicable.
-
setStep() protected
Set value for "step" attribute if applicable.
Method Detail
__construct() ¶ public
__construct(Cake\View\StringTemplate $templates, Cake\View\Widget\SelectBoxWidget $selectBox)Constructor
Parameters
-
Cake\View\StringTemplate$templates Templates list.
-
Cake\View\Widget\SelectBoxWidget$selectBox Selectbox widget instance.
mergeDefaults() ¶ protected
mergeDefaults(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): array<string, mixed>Merge default values with supplied data.
Parameters
-
array<string, mixed>$data Data array
-
Cake\View\Form\ContextInterface$context Context instance.
Returns
array<string, mixed>Updated data array.
render() ¶ public
render(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): stringRenders a year select box.
This method accepts a number of keys:
nameThe name attribute.valThe value attribute.escapeSet to false to disable escaping on all attributes.
Any other keys provided in $data will be converted into HTML attributes.
Parameters
-
array<string, mixed>$data Data to render with.
-
Cake\View\Form\ContextInterface$context The current form context.
Returns
stringA generated select box.
secureFields() ¶ public
secureFields(array<string, mixed> $data): array<string>Returns a list of fields that need to be secured for this widget.
Parameters
-
array<string, mixed>$data
Returns
array<string>setMaxLength() ¶ protected
setMaxLength(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>Set value for "maxlength" attribute if applicable.
Parameters
-
array<string, mixed>$data Data array
-
Cake\View\Form\ContextInterface$context Context instance.
-
string$fieldName Field name.
Returns
array<string, mixed>Updated data array.
setRequired() ¶ protected
setRequired(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>Set value for "required" attribute if applicable.
Parameters
-
array<string, mixed>$data Data array
-
Cake\View\Form\ContextInterface$context Context instance.
-
string$fieldName Field name.
Returns
array<string, mixed>Updated data array.
setStep() ¶ protected
setStep(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>Set value for "step" attribute if applicable.
Parameters
-
array<string, mixed>$data Data array
-
Cake\View\Form\ContextInterface$context Context instance.
-
string$fieldName Field name.
Returns
array<string, mixed>Updated data array.