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

Properties 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. Fields are in the form of Model[field][suffix]

Method Detail

__construct() public 

__construct(mixed $templates)

Constructor.

Parameters

\Cake\View\StringTemplate $templates

Templates list.

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

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

string[]

Array of fields to secure.

Property Detail

$_templates protected

StringTemplate instance.

Type

\Cake\View\StringTemplate

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