Docs4dev
Docs
cakephp / 3.2 / class-cake.view.widget.labelwidget.html

Class LabelWidget

Form 'widget' for creating labels.

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

Cake\View\Widget\LabelWidget implements Cake\View\Widget\WidgetInterface

Direct Subclasses

Namespace: Cake\View\Widget
Location: View/Widget/LabelWidget.php

Properties summary

Method Summary

  • Constructor.
  • render() public
    Render a label widget.

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

Implementation of

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

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

Properties detail

$_labelTemplatesource

protected string

The template to use.

'label'

$_templatessource

protected Cake\View\StringTemplate

Templates

© 2005–2016 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.
http://api.cakephp.org/3.2/class-Cake.View.Widget.LabelWidget.html