WebServCo\Framework\AbstractLibrary

Complexity

Total Complexity

11

Size/Duplication

Total Lines	117
Duplicated Lines	0 %

Importance

Changes	7
Bugs	2	Features	1

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	clearData()	0	4	1
A	setData()	0	7	2
A	dataElse()	0	3	1
A	toArray()	0	5	1
A	setting()	0	3	1
A	getData()	0	3	1
A	setSetting()	0	7	2
A	data()	0	3	1

<?php

declare(strict_types=1);

namespace WebServCo\Framework;

abstract class AbstractLibrary implements
    \WebServCo\Framework\Interfaces\ArrayInterface,
    \WebServCo\Framework\Interfaces\DataInterface,
    \WebServCo\Framework\Interfaces\LibraryInterface,
    \WebServCo\Framework\Interfaces\SettingsInterface
{
    /**
     * Data.
     *
     * @var array<mixed>
     */
    private array $data;

    /**
     * Settings.
     *
     * @var array<string,string|array<mixed>>
     */
    private array $settings;

    /**
    * @param array<string,string|array<mixed>> $settings
    */
    public function __construct(array $settings = [])
    {
        $this->clearData();

        $this->settings = $settings;
    }

    final public function clearData(): bool
    {
        $this->data = [];
        return true;
    }

    /**
     * Returns data if exists, $defaultValue otherwise.
     */
    final public function data(string $key, mixed $defaultValue = null): mixed
    {
        return \WebServCo\Framework\ArrayStorage::get($this->data, $key, $defaultValue);
    }

    /**
     * Returns data if not empty, $defaultValue otherwise.
     * $this->data returns data if it exists (can be empty).
     * This method returns data if both exists and not empty.
     *
     * @param mixed $defaultValue
     * @return mixed
     */
    final public function dataElse(string $key, $defaultValue = null)
    {
        return \WebServCo\Framework\ArrayStorage::getElse($this->data, $key, $defaultValue);
    }

    /**
    * @return array<mixed>
    */
    final public function getData(): array
    {
        return $this->data;
    }

    /**
     * @param mixed $key Can be an array, a string,
     *                          or a special formatted string
     *                          (eg 'i18n/lang').
     * @param mixed $value The value to be stored.
     * @return bool True on success and false on failure.
     */
    final public function setData($key, $value): bool
    {
        if (!$key) {
            return false;
        }
        $this->data = \WebServCo\Framework\ArrayStorage::set($this->data, $key, $value);
        return true;
    }

    /**
     * @param mixed $key Can be an array, a string,
     *                          or a special formatted string
     *                          (eg 'i18n/lang').
     * @param mixed $value The value to be stored.
     * @return bool True on success and false on failure.
     */
    final public function setSetting($key, $value): bool
    {
        if (!$key) {
            return false;
        }
        $this->settings = \WebServCo\Framework\ArrayStorage::set($this->settings, $key, $value);
        return true;
    }

    /**
    * @param mixed $key Can be an array, a string,
    *                          or a special formatted string
    *                          (eg 'i18n/lang').
    * @param mixed $defaultValue
    * @return mixed
    */
    final public function setting($key, $defaultValue = null)
    {
        return \WebServCo\Framework\ArrayStorage::get($this->settings, $key, $defaultValue);
    }

    /**
    * @return array<string, array<mixed>>
    */
    public function toArray(): array
    {
        return [
            'data' => $this->data,
            'settings' => $this->settings,
        ];
    }
}