Class ButtonWidget
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.
Namespace: Cake\View\Widget
Property Summary
-
$_templates protected
Cake\View\StringTemplate
StringTemplate instance.
Method Summary
-
__construct() public
Constructor.
-
render() public
Render a button.
-
secureFields() public
Returns a list of fields that need to be secured for this widget.
Method Detail
__construct() ¶ public
__construct(Cake\View\StringTemplate $templates)
Constructor.
Parameters
-
Cake\View\StringTemplate
$templates Templates list.
render() ¶ public
render(array<string, mixed> $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.escapeTitle
Set to false to disable escaping of button text.escape
Set to false to disable escaping of attributes.type
The button type defaults to 'submit'.
Any other keys provided in $data will be converted into HTML attributes.
Parameters
-
array<string, mixed>
$data The data to build a button with.
-
Cake\View\Form\ContextInterface
$context The current form context.
Returns
string
secureFields() ¶ public
secureFields(array<string, mixed> $data): list<string>
Returns a list of fields that need to be secured for this widget.
Parameters
-
array<string, mixed>
$data
Returns
list<string>