Interface LabelAwareTrait

Summary

Fully Qualified Name: Zend\Form\LabelAwareTrait

Description

Methods

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

Method Details

clearLabelOptions()

Clear all label options

Returns: \Element|\ElementInterface

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: \ElementInterface

removeLabelOptions()

Remove many attributes at once

Parameter Name Type Description
$keys array

Returns: \ElementInterface

setLabelAttributes()

Set the attributes to use with the label

Parameter Name Type Description
$labelAttributes array

Returns: \LabelAwareInterface

setLabelOption()

Set a single label optionn

Parameter Name Type Description
$key string
$value mixed

Returns: \Element|\ElementInterface

setLabelOptions()

Set many label options at once

Implementation will decide if this will overwrite or merge.

Parameter Name Type Description
$arrayOrTraversable array|\Traversable

Returns: \Element|\ElementInterface

Top