interface/modules/zend_modules/library/Zend/Form/ElementInterface.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-2013 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 ElementInterface
  13 {
  14     /**
  15      * Set the name of this element
  16      *
  17      * In most cases, this will proxy to the attributes for storage, but is
  18      * present to indicate that elements are generally named.
  19      *
  20      * @param  string $name
  21      * @return ElementInterface
  22      */
  23     public function setName($name);
  24
  25     /**
  26      * Retrieve the element name
  27      *
  28      * @return string
  29      */
  30     public function getName();
  31
  32     /**
  33      * Set options for an element
  34      *
  35      * @param  array|\Traversable $options
  36      * @return ElementInterface
  37      */
  38     public function setOptions($options);
  39
  40     /**
  41      * get the defined options
  42      *
  43      * @return array
  44      */
  45     public function getOptions();
  46
  47     /**
  48      * return the specified option
  49      *
  50      * @param string $option
  51      * @return null|mixed
  52      */
  53     public function getOption($option);
  54
  55     /**
  56      * Set a single element attribute
  57      *
  58      * @param  string $key
  59      * @param  mixed $value
  60      * @return ElementInterface
  61      */
  62     public function setAttribute($key, $value);
  63
  64     /**
  65      * Retrieve a single element attribute
  66      *
  67      * @param  string $key
  68      * @return mixed
  69      */
  70     public function getAttribute($key);
  71
  72     /**
  73      * Return true if a specific attribute is set
  74      *
  75      * @param  string $key
  76      * @return bool
  77      */
  78     public function hasAttribute($key);
  79
  80     /**
  81      * Set many attributes at once
  82      *
  83      * Implementation will decide if this will overwrite or merge.
  84      *
  85      * @param  array|\Traversable $arrayOrTraversable
  86      * @return ElementInterface
  87      */
  88     public function setAttributes($arrayOrTraversable);
  89
  90     /**
  91      * Retrieve all attributes at once
  92      *
  93      * @return array|\Traversable
  94      */
  95     public function getAttributes();
  96
  97     /**
  98      * Set the value of the element
  99      *
 100      * @param  mixed $value
 101      * @return ElementInterface
 102      */
 103     public function setValue($value);
 104
 105     /**
 106      * Retrieve the element value
 107      *
 108      * @return mixed
 109      */
 110     public function getValue();
 111
 112     /**
 113      * Set the label (if any) used for this element
 114      *
 115      * @param  $label
 116      * @return ElementInterface
 117      */
 118     public function setLabel($label);
 119
 120     /**
 121      * Retrieve the label (if any) used for this element
 122      *
 123      * @return string
 124      */
 125     public function getLabel();
 126
 127     /**
 128      * Set a list of messages to report when validation fails
 129      *
 130      * @param  array|\Traversable $messages
 131      * @return ElementInterface
 132      */
 133     public function setMessages($messages);
 134
 135     /**
 136      * Get validation error messages, if any
 137      *
 138      * Returns a list of validation failure messages, if any.
 139      *
 140      * @return array|\Traversable
 141      */
 142     public function getMessages();
 143 }