Docs4dev
Docs
cakephp / 3.8 / class-cake.view.widget.buttonwidget.html

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.

Cake\View\Widget\BasicWidget implements Cake\View\Widget\WidgetInterface
Extended by Cake\View\Widget\ButtonWidget
Namespace: Cake\View\Widget
Location: View/Widget/ButtonWidget.php

Inherited Properties

Method Summary

Method Detail

render()source public

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

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

Overrides

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

Methods inherited from Cake\View\Widget\BasicWidget

__construct()source public

__construct( Cake\View\StringTemplate $templates )

Constructor.

Parameters

Cake\View\StringTemplate $templates
Templates list.

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()

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