Class LabelWidget
Form 'widget' for creating labels.
Generally this element is used by other widgets, and FormHelper itself.
Namespace: Cake\View\Widget
Property Summary
-
$_labelTemplate protected
string
The template to use.
-
$_templates protected
Cake\View\StringTemplate
Templates
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.
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): 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() ¶ public
secureFields(array $data): string[]
Returns a list of fields that need to be secured for this widget.
Parameters
-
array
$data
Returns
string[]