interface/modules/zend_modules/library/Zend/Form/LabelAwareInterface.php

   1 <?php
   2 /**
   3  * Zend Framework (http://framework.zend.com/)
   4  *
   5  * @link      http://github.com/zendframework/zf2 for the canonical source repository
   6  * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
   7  * @license   http://framework.zend.com/license/new-bsd New BSD License
   8  */
   9
  10 namespace Zend\Form;
  11
  12 interface LabelAwareInterface
  13 {
  14     /**
  15      * Set the label (if any) used for this element
  16      *
  17      * @param  $label
  18      * @return ElementInterface
  19      */
  20     public function setLabel($label);
  21
  22     /**
  23      * Retrieve the label (if any) used for this element
  24      *
  25      * @return string
  26      */
  27     public function getLabel();
  28
  29     /**
  30      * Set the attributes to use with the label
  31      *
  32      * @param array $labelAttributes
  33      * @return self
  34      */
  35     public function setLabelAttributes(array $labelAttributes);
  36
  37     /**
  38      * Get the attributes to use with the label
  39      *
  40      * @return array
  41      */
  42     public function getLabelAttributes();
  43
  44     /**
  45      * Set many label options at once
  46      *
  47      * Implementation will decide if this will overwrite or merge.
  48      *
  49      * @param  array|\Traversable $arrayOrTraversable
  50      * @return self
  51      */
  52     public function setLabelOptions($arrayOrTraversable);
  53
  54     /**
  55      * Get label specific options
  56      *
  57      * @return array
  58      */
  59     public function getLabelOptions();
  60
  61      /**
  62      * Set a single label optionn
  63      *
  64      * @param  string $key
  65      * @param  mixed  $value
  66      * @return Element|ElementInterface
  67      */
  68     public function setLabelOption($key, $value);
  69
  70     /**
  71      * Retrieve a single label option
  72      *
  73      * @param  $key
  74      * @return mixed|null
  75      */
  76     public function getLabelOption($key);
  77
  78     /**
  79      * Remove a single label option
  80      *
  81      * @param string $key
  82      * @return ElementInterface
  83      */
  84     public function removeLabelOption($key);
  85
  86     /**
  87      * Does the element has a specific label option ?
  88      *
  89      * @param  string $key
  90      * @return bool
  91      */
  92     public function hasLabelOption($key);
  93
  94     /**
  95      * Remove many attributes at once
  96      *
  97      * @param array $keys
  98      * @return ElementInterface
  99      */
 100     public function removeLabelOptions(array $keys);
 101
 102     /**
 103      * Clear all label options
 104      *
 105      * @return Element|ElementInterface
 106      */
 107     public function clearLabelOptions();
 108 }