\Cake\View\WidgetButtonWidget

Button input class

This input class can be used to render button elements. If you need to make basic submit inputs with type=submit, use the Basic input widget.

Summary

Methods
Properties
Constants
__construct()
render()
secureFields()
No public properties found
No constants found
No protected methods found
$_templates
N/A
No private methods found
No private properties found
N/A

Properties

Methods

__construct()

__construct(\Cake\View\StringTemplate  $templates) 

Constructor.

Parameters

\Cake\View\StringTemplate $templates

Templates list.

render()

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

Render a button.

This method accepts a number of keys:

  • text The text of the button. Unlike all other form controls, buttons do not escape their contents by default.
  • escape Set to true to enable escaping on all attributes.
  • type The button type defaults to 'submit'.

Any other keys provided in $data will be converted into HTML attributes.

Parameters

array $data

The data to build a button with.

\Cake\View\Form\ContextInterface $context

The current form context.

Returns

string

secureFields()

secureFields(array  $data) : array

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.