interface/modules/zend_modules/library/Zend/Stdlib/AbstractOptions.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\Stdlib;
  11
  12 use Traversable;
  13
  14 abstract class AbstractOptions implements ParameterObjectInterface
  15 {
  16     /**
  17      * We use the __ prefix to avoid collisions with properties in
  18      * user-implementations.
  19      *
  20      * @var bool
  21      */
  22     protected $__strictMode__ = true;
  23
  24     /**
  25      * Constructor
  26      *
  27      * @param  array|Traversable|null $options
  28      */
  29     public function __construct($options = null)
  30     {
  31         if (null !== $options) {
  32             $this->setFromArray($options);
  33         }
  34     }
  35
  36     /**
  37      * Set one or more configuration properties
  38      *
  39      * @param  array|Traversable|AbstractOptions $options
  40      * @throws Exception\InvalidArgumentException
  41      * @return AbstractOptions Provides fluent interface
  42      */
  43     public function setFromArray($options)
  44     {
  45         if ($options instanceof self) {
  46             $options = $options->toArray();
  47         }
  48
  49         if (!is_array($options) && !$options instanceof Traversable) {
  50             throw new Exception\InvalidArgumentException(sprintf(
  51                 'Parameter provided to %s must be an %s, %s or %s',
  52                 __METHOD__, 'array', 'Traversable', 'Zend\Stdlib\AbstractOptions'
  53             ));
  54         }
  55
  56         foreach ($options as $key => $value) {
  57             $this->__set($key, $value);
  58         }
  59
  60         return $this;
  61     }
  62
  63     /**
  64      * Cast to array
  65      *
  66      * @return array
  67      */
  68     public function toArray()
  69     {
  70         $array = array();
  71         $transform = function ($letters) {
  72             $letter = array_shift($letters);
  73             return '_' . strtolower($letter);
  74         };
  75         foreach ($this as $key => $value) {
  76             if ($key === '__strictMode__') continue;
  77             $normalizedKey = preg_replace_callback('/([A-Z])/', $transform, $key);
  78             $array[$normalizedKey] = $value;
  79         }
  80         return $array;
  81     }
  82
  83     /**
  84      * Set a configuration property
  85      *
  86      * @see ParameterObject::__set()
  87      * @param string $key
  88      * @param mixed $value
  89      * @throws Exception\BadMethodCallException
  90      * @return void
  91      */
  92     public function __set($key, $value)
  93     {
  94         $setter = 'set' . str_replace(' ', '', ucwords(str_replace('_', ' ', $key)));
  95         if ($this->__strictMode__ && !method_exists($this, $setter)) {
  96             throw new Exception\BadMethodCallException(
  97                 'The option "' . $key . '" does not '
  98                 . 'have a matching ' . $setter . ' setter method '
  99                 . 'which must be defined'
 100             );
 101         } elseif (!$this->__strictMode__ && !method_exists($this, $setter)) {
 102             return;
 103         }
 104         $this->{$setter}($value);
 105     }
 106
 107     /**
 108      * Get a configuration property
 109      *
 110      * @see ParameterObject::__get()
 111      * @param string $key
 112      * @throws Exception\BadMethodCallException
 113      * @return mixed
 114      */
 115     public function __get($key)
 116     {
 117         $getter = 'get' . str_replace(' ', '', ucwords(str_replace('_', ' ', $key)));
 118         if (!method_exists($this, $getter)) {
 119             throw new Exception\BadMethodCallException(
 120                 'The option "' . $key . '" does not '
 121                 . 'have a matching ' . $getter . ' getter method '
 122                 . 'which must be defined'
 123             );
 124         }
 125
 126         return $this->{$getter}();
 127     }
 128
 129     /**
 130      * Test if a configuration property is null
 131      * @see ParameterObject::__isset()
 132      * @param string $key
 133      * @return bool
 134      */
 135     public function __isset($key)
 136     {
 137         return null !== $this->__get($key);
 138     }
 139
 140     /**
 141      * Set a configuration property to NULL
 142      *
 143      * @see ParameterObject::__unset()
 144      * @param string $key
 145      * @throws Exception\InvalidArgumentException
 146      * @return void
 147      */
 148     public function __unset($key)
 149     {
 150         try {
 151             $this->__set($key, null);
 152         } catch (Exception\BadMethodCallException $e) {
 153             throw new Exception\InvalidArgumentException(
 154                 'The class property $' . $key . ' cannot be unset as'
 155                     . ' NULL is an invalid value for it',
 156                 0,
 157                 $e
 158             );
 159         }
 160     }
 161 }