Interface LabelAwareInterface

Summary

Fully Qualified Name: Laminas\Form\LabelAwareInterface

Description

Methods

Name Description Defined By
clearLabelOptions() Clear all label options LabelAwareInterface
getLabel() Retrieve the label (if any) used for this element LabelAwareInterface
getLabelAttributes() Get the attributes to use with the label LabelAwareInterface
getLabelOption() Retrieve a single label option LabelAwareInterface
getLabelOptions() Get label specific options LabelAwareInterface
hasLabelOption() Does the element has a specific label option ? LabelAwareInterface
removeLabelOption() Remove a single label option LabelAwareInterface
removeLabelOptions() Remove many attributes at once LabelAwareInterface
setLabel() Set the label (if any) used for this element LabelAwareInterface
setLabelAttributes() Set the attributes to use with the label LabelAwareInterface
setLabelOption() Set a single label optionn LabelAwareInterface
setLabelOptions() Set many label options at once LabelAwareInterface

Method Details

clearLabelOptions()

Clear all label options

Returns: $this

getLabel()

Retrieve the label (if any) used for this element

Returns: string

getLabelAttributes()

Get the attributes to use with the label

Returns: array

getLabelOption()

Retrieve a single label option

Parameter Name Type Description
$key
$key

Returns: mixed|null

getLabelOptions()

Get label specific options

Returns: array

hasLabelOption()

Does the element has a specific label option ?

Parameter Name Type Description
$key string

Returns: bool

removeLabelOption()

Remove a single label option

Parameter Name Type Description
$key string

Returns: $this

removeLabelOptions()

Remove many attributes at once

Parameter Name Type Description
$keys array

Returns: $this

setLabel()

Set the label (if any) used for this element

Parameter Name Type Description
$label
$label

Returns: $this

setLabelAttributes()

Set the attributes to use with the label

Parameter Name Type Description
$labelAttributes array

Returns: $this

setLabelOption()

Set a single label optionn

Parameter Name Type Description
$key string
$value mixed

Returns: $this

setLabelOptions()

Set many label options at once

Implementation will decide if this will overwrite or merge.

Parameter Name Type Description
$arrayOrTraversable array|\Traversable

Returns: $this

Top