Class FileWidget

Input widget class for generating a file upload control.

This class is intended as an internal implementation detail of Cake\View\Helper\FormHelper and is not intended for direct use.

Cake\View\Widget\FileWidget implements Cake\View\Widget\WidgetInterface

Properties summary

Method Summary

  • __construct() public
    Constructor
  • render() public
    Render a file upload form widget.
  • Returns a list of fields that need to be secured for this widget. Fields are in the form of Model[field][suffix]

Method Detail

__construct()source public

__construct( Cake\View\StringTemplate $templates )

Constructor

Parameters

Cake\View\StringTemplate $templates
Templates list.

render()source public

render( array $data , Cake\View\Form\ContextInterface $context )

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.

Parameters

array $data
The data to build a file input with.
Cake\View\Form\ContextInterface $context
The current form context.

Returns

string
HTML elements.

Implementation of

Cake\View\Widget\WidgetInterface::render()

secureFields()source public

secureFields( array $data )

Returns a list of fields that need to be secured for this widget. Fields are in the form of Model[field][suffix]

Parameters

array $data
The data to render.

Returns

array
Array of fields to secure.

Implementation of

Cake\View\Widget\WidgetInterface::secureFields()

Properties detail

$_templatessource

protected Cake\View\StringTemplate

Templates

© 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/3.6/class-Cake.View.Widget.FileWidget.html