\Cake\View\WidgetNestingLabelWidget

Form 'widget' for creating labels that contain their input.

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

Summary

Methods
Properties
Constants
__construct()
render()
secureFields()
No public properties found
No constants found
No protected methods found
$_templates
$_labelTemplate
N/A
No private methods found
No private properties found
N/A

Properties

$_labelTemplate

$_labelTemplate : string

The template to use.

Type

string

Methods

__construct()

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

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

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

secureFields(array  $data) : array

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.