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
protectedstring
The template to use. -
$_templates
protectedTemplates
Method Summary
-
__construct() public
Constructor. -
render() public
Render 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() 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() 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
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
array
Array of fields to secure.
Array of fields to secure.