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
Properties summary
-
$_labelTemplate
protectedThe template to use.string
-
$_templates
protected
Method Summary
- __construct() publicConstructor.
- render() publicRender a label widget.
- 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()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 variablesattrs
,text
andinput
.
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
stringImplementation 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
arrayArray of fields to secure.
Implementation of
Cake\View\Widget\WidgetInterface::secureFields()
Properties detail
© 2005–2017 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.4/class-Cake.View.Widget.LabelWidget.html