Class LabelWidget

Form 'widget' for creating labels.

Generally this element is used by other widgets, and FormHelper itself.

Namespace: Cake\View\Widget

Properties summary

Method Summary

Method Detail

__construct() public 

__construct(\Cake\View\StringTemplate $templates)

Constructor.

This class uses the following template:

  • label Used to generate the label for a radio button. Can use the following variables attrs, text and input.

Parameters

\Cake\View\StringTemplate $templates

Templates list.

render() public 

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

Render a label widget.

Accepts the following keys in $data:

  • text The text for the label.
  • input The input that can be formatted into the label if the template allows it.
  • escape Set to false to disable HTML escaping.

All other attributes will be converted into HTML attributes.

Parameters

array $data

Data array.

\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.

Parameters

array $data

The data to render.

Returns

string[]

Array of fields to secure.

Property Detail

$_labelTemplate protected

The template to use.

Type

string

$_templates protected

Templates

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/4.0/class-Cake.View.Widget.LabelWidget.html