interface/modules/zend_modules/library/Zend/Tag/Item.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\Tag;
  11
  12 use Traversable;
  13 use Zend\Stdlib\ArrayUtils;
  14
  15 class Item implements TaggableInterface
  16 {
  17     /**
  18      * Title of the tag
  19      *
  20      * @var string
  21      */
  22     protected $title = null;
  23
  24     /**
  25      * Weight of the tag
  26      *
  27      * @var float
  28      */
  29     protected $weight = null;
  30
  31     /**
  32      * Custom parameters
  33      *
  34      * @var string
  35      */
  36     protected $params = array();
  37
  38     /**
  39      * Option keys to skip when calling setOptions()
  40      *
  41      * @var array
  42      */
  43     protected $skipOptions = array(
  44         'options',
  45         'param'
  46     );
  47
  48     /**
  49      * Create a new tag according to the options
  50      *
  51      * @param  array|Traversable $options
  52      * @throws \Zend\Tag\Exception\InvalidArgumentException When invalid options are provided
  53      * @throws \Zend\Tag\Exception\InvalidArgumentException When title was not set
  54      * @throws \Zend\Tag\Exception\InvalidArgumentException When weight was not set
  55      */
  56     public function __construct($options)
  57     {
  58         if ($options instanceof Traversable) {
  59             $options = ArrayUtils::iteratorToArray($options);
  60         }
  61
  62         if (!is_array($options)) {
  63             throw new Exception\InvalidArgumentException('Invalid options provided to constructor');
  64         }
  65
  66         $this->setOptions($options);
  67
  68         if ($this->title === null) {
  69             throw new Exception\InvalidArgumentException('Title was not set');
  70         }
  71
  72         if ($this->weight === null) {
  73             throw new Exception\InvalidArgumentException('Weight was not set');
  74         }
  75     }
  76
  77     /**
  78      * Set options of the tag
  79      *
  80      * @param  array $options
  81      * @return \Zend\Tag\Item
  82      */
  83     public function setOptions(array $options)
  84     {
  85         foreach ($options as $key => $value) {
  86             if (in_array(strtolower($key), $this->skipOptions)) {
  87                 continue;
  88             }
  89
  90             $method = 'set' . $key;
  91             if (method_exists($this, $method)) {
  92                 $this->$method($value);
  93             }
  94         }
  95
  96         return $this;
  97     }
  98
  99     /**
 100      * Defined by Zend\Tag\TaggableInterface
 101      *
 102      * @return string
 103      */
 104     public function getTitle()
 105     {
 106         return $this->title;
 107     }
 108
 109     /**
 110      * Set the title
 111      *
 112      * @param  string $title
 113      * @throws \Zend\Tag\Exception\InvalidArgumentException When title is no string
 114      * @return \Zend\Tag\Item
 115      */
 116     public function setTitle($title)
 117     {
 118         if (!is_string($title)) {
 119             throw new Exception\InvalidArgumentException('Title must be a string');
 120         }
 121
 122         $this->title = (string) $title;
 123         return $this;
 124     }
 125
 126     /**
 127      * Defined by Zend\Tag\TaggableInterface
 128      *
 129      * @return float
 130      */
 131     public function getWeight()
 132     {
 133         return $this->weight;
 134     }
 135
 136     /**
 137      * Set the weight
 138      *
 139      * @param  float $weight
 140      * @throws \Zend\Tag\Exception\InvalidArgumentException When weight is not numeric
 141      * @return \Zend\Tag\Item
 142      */
 143     public function setWeight($weight)
 144     {
 145         if (!is_numeric($weight)) {
 146             throw new Exception\InvalidArgumentException('Weight must be numeric');
 147         }
 148
 149         $this->weight = (float) $weight;
 150         return $this;
 151     }
 152
 153     /**
 154      * Set multiple params at once
 155      *
 156      * @param  array $params
 157      * @return \Zend\Tag\Item
 158      */
 159     public function setParams(array $params)
 160     {
 161         foreach ($params as $name => $value) {
 162             $this->setParam($name, $value);
 163         }
 164
 165         return $this;
 166     }
 167
 168     /**
 169      * Defined by Zend\Tag\TaggableInterface
 170      *
 171      * @param  string $name
 172      * @param  mixed  $value
 173      * @return \Zend\Tag\Item
 174      */
 175     public function setParam($name, $value)
 176     {
 177         $this->params[$name] = $value;
 178         return $this;
 179     }
 180
 181     /**
 182      * Defined by Zend\Tag\TaggableInterface
 183      *
 184      * @param  string $name
 185      * @return mixed
 186      */
 187     public function getParam($name)
 188     {
 189         if (isset($this->params[$name])) {
 190             return $this->params[$name];
 191         }
 192         return null;
 193     }
 194 }