Brownie\Util\StorageList

Complexity

Total Complexity

9

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getInitData()	0	3	1
A	__construct()	0	3	1
A	get()	0	8	2
A	setInitData()	0	4	1
A	toArray()	0	4	1
A	setList()	0	4	1
A	initList()	0	4	2

<?php
/**
 * @category    Brownie/Util
 * @author      Brownie <oss.brownie@gmail.com>
 * @license     https://opensource.org/licenses/MIT
 */

namespace Brownie\Util;

/**
 * Storage of data in the form of a list.
 */
class StorageList
{

    /**
     * Data to initialize the list.
     *
     * @var mixed
     */
    private $initData;

    /**
     * List.
     *
     * @var array
     */
    private $list;

    /**
     * Sets incoming values.
     *
     * @param mixed     $initData   Data to initialize the list.
     */
    public function __construct($initData = array())
    {
        $this->setInitData($initData);
    }

    /**
     * Sets data to initialize the list.
     *
     * @param mixed     $initData       Data for initialization.
     *
     * @return self
     */
    private function setInitData($initData)
    {
        $this->initData = $initData;
        return $this;
    }

    /**
     * Gets data to initialize the list.
     *
     * @return mixed
     */
    protected function getInitData()
    {
        return $this->initData;
    }

    /**
     * Gets value of by key name.
     *
     * @param string    $keyName            Key name.
     * @param mixed     $defaultValue       Default value.
     *
     * @return string|mixed
     */
    public function get($keyName, $defaultValue = null)
    {
        $this->initList();
        $keyName = strtolower($keyName);
        if (empty($this->list[$keyName])) {
            return $defaultValue;
        }
        return $this->list[$keyName];
    }

    /**
     * Returns the container as an array.
     *
     * @return array
     */
    public function toArray()
    {
        $this->initList();
        return $this->list;
    }

    /**
     * Sets the list.
     *
     * @param array     $list   List.
     *
     * @return self
     */
    protected function setList(array $list)
    {
        $this->list = $list;
        return $this;
    }

    /**
     * Initializes and sets the list.
     */
    protected function initList()
    {
        if (empty($this->list)) {
            $this->setList($this->getInitData());
        }
    }
}