Input widget class for generating a file upload control.
This class is usually used internally by Cake\View\Helper\FormHelper
, it but can be used to generate standalone file upload controls.
Cake\View\StringTemplate
StringTemplate instance.
array<string, mixed>
Data defaults.
Constructor.
Merge default values with supplied data.
Render a file upload form widget.
Returns a list of fields that need to be secured for this widget.
Set value for "maxlength" attribute if applicable.
Set value for "required" attribute if applicable.
Set value for "step" attribute if applicable.
__construct(Cake\View\StringTemplate $templates)
Constructor.
Cake\View\StringTemplate
$templates Templates list.
mergeDefaults(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): array<string, mixed>
Merge default values with supplied data.
array<string, mixed>
$data Data array
Cake\View\Form\ContextInterface
$context Context instance.
array<string, mixed>
render(array<string, mixed> $data, Cake\View\Form\ContextInterface $context): string
Render a file upload form widget.
Data supports the following keys:
name
- Set the input name.escape
- Set to false to disable HTML escaping.All other keys will be converted into HTML attributes. Unlike other input objects the val
property will be specifically ignored.
array<string, mixed>
$data The data to build a file input with.
Cake\View\Form\ContextInterface
$context The current form context.
string
secureFields(array<string, mixed> $data): array<string>
Returns a list of fields that need to be secured for this widget.
array<string, mixed>
$data array<string>
setMaxLength(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>
Set value for "maxlength" attribute if applicable.
array<string, mixed>
$data Data array
Cake\View\Form\ContextInterface
$context Context instance.
string
$fieldName Field name.
array<string, mixed>
setRequired(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>
Set value for "required" attribute if applicable.
array<string, mixed>
$data Data array
Cake\View\Form\ContextInterface
$context Context instance.
string
$fieldName Field name.
array<string, mixed>
setStep(array<string, mixed> $data, Cake\View\Form\ContextInterface $context, string $fieldName): array<string, mixed>
Set value for "step" attribute if applicable.
array<string, mixed>
$data Data array
Cake\View\Form\ContextInterface
$context Context instance.
string
$fieldName Field name.
array<string, mixed>
StringTemplate instance.
Cake\View\StringTemplate
Data defaults.
array<string, mixed>
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.View.Widget.FileWidget.html