<?php

namespace App\Service\Moz;

use InvalidArgumentException;

/**
 * Base class for configurable classes.
 *
 * All classes extending this class are  configurable using the constructor or
 * setOption calls. This is the base  providing a
 * uniform interface for various models.
 */
class Configurable implements ConfigurableInterface
{
    /**
     * Default options.
     *
     * @var array
     */
    protected $options = [];

    /**
     * Constructor.
     *
     * If options are passed they will be merged with {@link $options} using
     * the {@link setOptions()} method.
     *
     * After handling the options the {@link _init()} method is called.
     *
     *
     * @param array $options
     *
     * @throws InvalidArgumentException
     */
    public function __construct($options = null)
    {
        if (null !== $options) {
            $this->setOptions($options);
        } else {
            $this->init();
        }
    }

    /**
     * Set options.
     *
     * If $options is an object, it will be converted into an array by calling
     * its toArray method. This is compatible with the Zend_Config classes in
     * Zend Framework, but can also easily be implemented in any other object.
     * If $options does not have the toArray method, the internal method will
     * be used instead.
     *
     *
     * @param array $options
     * @param bool  $overwrite True for overwriting existing options, false
     *                         for merging (new values overwrite old ones if needed)
     *
     * @throws InvalidArgumentException
     */
    public function setOptions($options, $overwrite = false)
    {
        if (null !== $options) {
            // first convert to array if needed
            if (!is_array($options)) {
                if (is_object($options)) {
                    $options = (!method_exists($options, 'toArray') ? $this->toArray($options) : $options->toArray());
                } else {
                    throw new InvalidArgumentException(
                        'Options value given to the setOptions() method must be an array or a Zend_Config object'
                    );
                }
            }

            if (true === $overwrite) {
                $this->options = $options;
            } else {
                $this->options = array_merge($this->options, $options);
            }

            // re-init for new options
            $this->init();
        }
    }

    /**
     * Get an option value by name.
     *
     * If the option is empty or not set a NULL value will be returned.
     *
     * @param string $name
     *
     * @return mixed
     */
    public function getOption($name)
    {
        if (isset($this->options[$name])) {
            return $this->options[$name];
        }
    }

    /**
     * Get all options.
     *
     * @return array
     */
    public function getOptions()
    {
        return $this->options;
    }

    /**
     * Initialization hook.
     *
     * Can be used by classes for special behaviour. For instance some options
     * have extra setup work in their 'set' method that also need to be called
     * when the option is passed as a constructor argument.
     *
     * This hook is called by the constructor after saving the constructor
     * arguments in {@link $options}
     *
     * This empty implementation can optionally be implemented in
     * descending classes. It's not an abstract method on purpose, there are
     * many cases where no initialization is needed.
     */
    protected function init()
    {
    }

    /**
     * Set an option.
     *
     * @param string $name
     * @param mixed  $value
     *
     * @return self Provides fluent interface
     */
    protected function setOption($name, $value)
    {
        $this->options[$name] = $value;

        return $this;
    }

    /**
     * Turns an object array into an associative multidimensional array.
     *
     * @param $object
     *
     * @return array|object
     */
    protected function toArray(object $object)
    {
        if (is_object($object)) {
            // get_object_vars() does not handle recursive objects well,
            // so use set-type without scope operator instead
            settype($object, 'array');
        }

        /*
        * Return array converted to object
        * Using __METHOD__ (Magic constant)
        * for recursive call
        */
        if (is_array($object)) {
            return array_map(__METHOD__, $object);
        }

        return $object;
    }
}
