Bluz\Common\Options

Complexity

Total Complexity

10

Size/Duplication

Total Lines	104
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

0%

Importance

Changes

0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getOption()	0	12	3
A	setOption()	0	9	2
A	getOptions()	0	4	1
A	setOptions()	0	15	2
A	initOptions()	0	4	1
A	normalizeKey()	0	6	1

<?php
/**
 * Bluz Framework Component
 *
 * @copyright Bluz PHP Team
 * @link https://github.com/bluzphp/framework
 */

declare(strict_types=1);

namespace Bluz\Common;

/**
 * Options Trait
 *
 * Example of usage
 *     class Foo
 *     {
 *       use \Bluz\Common\Options;
 *
 *       protected $bar = '';
 *       protected $baz = '';
 *
 *       public function setBar($value)
 *       {
 *           $this->bar = $value;
 *       }
 *
 *       public function setBaz($value)
 *       {
 *           $this->baz = $value;
 *       }
 *     }
 *
 *     $Foo = new Foo(['bar'=>123, 'baz'=>456]);
 *
 * @package  Bluz\Common
 * @author   Anton Shevchuk
 * @link     https://github.com/bluzphp/framework/wiki/Trait-Options
 */
trait Options
{
    /**
     * @var array options store
     */
    protected $options;

    /**
     * Get option by key
     *
     * @param  string      $key
     * @param  string|null $section
     * @return mixed
     */
    public function getOption($key, $section = null)
    {
        if (isset($this->options[$key])) {
            if (!is_null($section)) {
                return $this->options[$key][$section] ?? null;
            } else {
                return $this->options[$key];
            }
        } else {
            return null;
        }
    }

    /**
     * Set option by key over setter
     *
     * @param  string $key
     * @param  string $value
     * @return void
     */
    public function setOption($key, $value)
    {
        $method = 'set' . $this->normalizeKey($key);
        if (method_exists($this, $method)) {
            $this->$method($value);
        } else {
            $this->options[$key] = $value;
        }
    }

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

    /**
     * Setup, check and init options
     *
     * Requirements
     * - options must be a array
     * - options can be null
     *
     * @param  array $options
     * @return self
     */
    public function setOptions(array $options = null)
    {
        // store options by default
        $this->options = (array) $options;

        // apply options
        foreach ($this->options as $key => $value) {
            $this->setOption($key, $value);
        }

        // check and initialize options
        $this->initOptions();

        return $this;
    }

    /**
     * Check and initialize options in package
     *
     * @throws \Bluz\Config\ConfigException
     * @return void
     */
    protected function initOptions()
    {
        return;
    }

    /**
     * Normalize key name
     *
     * @param  string $key
     * @return string
     */
    private function normalizeKey($key)
    {
        $option = str_replace(['_', '-'], ' ', strtolower($key));
        $option = str_replace(' ', '', ucwords($option));
        return $option;
    }
}