Zend Framework  3.0
Public Member Functions | List of all members
LabelAwareInterface Interface Reference

Public Member Functions

 setLabel ($label)
 Set the label (if any) used for this element.
 
 getLabel ()
 Retrieve the label (if any) used for this element.
 
 setLabelAttributes (array $labelAttributes)
 Set the attributes to use with the label.
 
 getLabelAttributes ()
 Get the attributes to use with the label.
 
 setLabelOptions ($arrayOrTraversable)
 Set many label options at once.
 
 getLabelOptions ()
 Get label specific options.
 
 setLabelOption ($key, $value)
 Set a single label optionn.
 
 getLabelOption ($key)
 Retrieve a single label option.
 
 removeLabelOption ($key)
 Remove a single label option.
 
 hasLabelOption ($key)
 Does the element has a specific label option ?
 
 removeLabelOptions (array $keys)
 Remove many attributes at once.
 
 clearLabelOptions ()
 Clear all label options.
 

Member Function Documentation

clearLabelOptions ( )

Clear all label options.

Returns
Element|ElementInterface

Implemented in Element.

getLabel ( )

Retrieve the label (if any) used for this element.

Returns
string

Implemented in Element.

getLabelAttributes ( )

Get the attributes to use with the label.

Returns
array

Implemented in Element.

getLabelOption (   $key)

Retrieve a single label option.

Parameters
$key
Returns
mixed|null

Implemented in Element.

getLabelOptions ( )

Get label specific options.

Returns
array

Implemented in Element.

hasLabelOption (   $key)

Does the element has a specific label option ?

Parameters
string$key
Returns
bool

Implemented in Element.

removeLabelOption (   $key)

Remove a single label option.

Parameters
string$key
Returns
ElementInterface

Implemented in Element.

removeLabelOptions ( array  $keys)

Remove many attributes at once.

Parameters
array$keys
Returns
ElementInterface

Implemented in Element.

setLabel (   $label)

Set the label (if any) used for this element.

Parameters
$label
Returns
ElementInterface

Implemented in Element.

setLabelAttributes ( array  $labelAttributes)

Set the attributes to use with the label.

Parameters
array$labelAttributes
Returns
self

Implemented in Element.

setLabelOption (   $key,
  $value 
)

Set a single label optionn.

Parameters
string$key
mixed$value
Returns
Element|ElementInterface

Implemented in Element.

setLabelOptions (   $arrayOrTraversable)

Set many label options at once.

Implementation will decide if this will overwrite or merge.

Parameters
array | \Traversable$arrayOrTraversable
Returns
self

Implemented in Element.