123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161 |
- <?php
- /**
- * Zend Framework (http://framework.zend.com/)
- *
- * @link http://github.com/zendframework/zf2 for the canonical source repository
- * @copyright Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- * @license http://framework.zend.com/license/new-bsd New BSD License
- */
- namespace Zend\Stdlib;
- use Traversable;
- abstract class AbstractOptions implements ParameterObjectInterface
- {
- /**
- * We use the __ prefix to avoid collisions with properties in
- * user-implementations.
- *
- * @var bool
- */
- protected $__strictMode__ = true;
- /**
- * Constructor
- *
- * @param array|Traversable|null $options
- */
- public function __construct($options = null)
- {
- if (null !== $options) {
- $this->setFromArray($options);
- }
- }
- /**
- * Set one or more configuration properties
- *
- * @param array|Traversable|AbstractOptions $options
- * @throws Exception\InvalidArgumentException
- * @return AbstractOptions Provides fluent interface
- */
- public function setFromArray($options)
- {
- if ($options instanceof self) {
- $options = $options->toArray();
- }
- if (!is_array($options) && !$options instanceof Traversable) {
- throw new Exception\InvalidArgumentException(sprintf(
- 'Parameter provided to %s must be an %s, %s or %s',
- __METHOD__, 'array', 'Traversable', 'Zend\Stdlib\AbstractOptions'
- ));
- }
- foreach ($options as $key => $value) {
- $this->__set($key, $value);
- }
- return $this;
- }
- /**
- * Cast to array
- *
- * @return array
- */
- public function toArray()
- {
- $array = array();
- $transform = function ($letters) {
- $letter = array_shift($letters);
- return '_' . strtolower($letter);
- };
- foreach ($this as $key => $value) {
- if ($key === '__strictMode__') continue;
- $normalizedKey = preg_replace_callback('/([A-Z])/', $transform, $key);
- $array[$normalizedKey] = $value;
- }
- return $array;
- }
- /**
- * Set a configuration property
- *
- * @see ParameterObject::__set()
- * @param string $key
- * @param mixed $value
- * @throws Exception\BadMethodCallException
- * @return void
- */
- public function __set($key, $value)
- {
- $setter = 'set' . str_replace(' ', '', ucwords(str_replace('_', ' ', $key)));
- if ($this->__strictMode__ && !method_exists($this, $setter)) {
- throw new Exception\BadMethodCallException(
- 'The option "' . $key . '" does not '
- . 'have a matching ' . $setter . ' setter method '
- . 'which must be defined'
- );
- } elseif (!$this->__strictMode__ && !method_exists($this, $setter)) {
- return;
- }
- $this->{$setter}($value);
- }
- /**
- * Get a configuration property
- *
- * @see ParameterObject::__get()
- * @param string $key
- * @throws Exception\BadMethodCallException
- * @return mixed
- */
- public function __get($key)
- {
- $getter = 'get' . str_replace(' ', '', ucwords(str_replace('_', ' ', $key)));
- if (!method_exists($this, $getter)) {
- throw new Exception\BadMethodCallException(
- 'The option "' . $key . '" does not '
- . 'have a matching ' . $getter . ' getter method '
- . 'which must be defined'
- );
- }
- return $this->{$getter}();
- }
- /**
- * Test if a configuration property is null
- * @see ParameterObject::__isset()
- * @param string $key
- * @return bool
- */
- public function __isset($key)
- {
- return null !== $this->__get($key);
- }
- /**
- * Set a configuration property to NULL
- *
- * @see ParameterObject::__unset()
- * @param string $key
- * @throws Exception\InvalidArgumentException
- * @return void
- */
- public function __unset($key)
- {
- try {
- $this->__set($key, null);
- } catch (Exception\BadMethodCallException $e) {
- throw new Exception\InvalidArgumentException(
- 'The class property $' . $key . ' cannot be unset as'
- . ' NULL is an invalid value for it',
- 0,
- $e
- );
- }
- }
- }
|