Bluz\Container\Container

Complexity

Total Complexity

10

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	doDeleteContainer()	0	3	1
A	toArray()	0	3	1
A	doContainsContainer()	0	3	1
A	doGetContainer()	0	6	2
A	doSetContainer()	0	3	1
A	setFromArray()	0	4	2
A	resetArray()	0	4	2

<?php

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

declare(strict_types=1);

namespace Bluz\Container;

/**
 * Container of data for an object
 *
 * @package  Bluz\Common
 * @author   Anton Shevchuk
 * @link     https://github.com/bluzphp/framework/wiki/Trait-Container
 */
trait Container
{
    /**
     * @var array Container of elements
     */
    protected array $container = [];

    /**
     * Set key/value pair
     *
     * @param string $key
     * @param  mixed  $value
     *
     * @return void
     */
    protected function doSetContainer(string $key, mixed $value): void
    {
        $this->container[$key] = $value;
    }

    /**
     * Get value by key
     *
     * @param string $key
     *
     * @return mixed
     */
    protected function doGetContainer(string $key): mixed
    {
        if ($this->doContainsContainer($key)) {
            return $this->container[$key];
        }
        return null;
    }

    /**
     * Check contains key in container
     *
     * @param string $key
     *
     * @return bool
     */
    protected function doContainsContainer(string $key): bool
    {
        return array_key_exists($key, $this->container);
    }

    /**
     * Delete value by key
     *
     * @param string $key
     *
     * @return void
     */
    protected function doDeleteContainer(string $key): void
    {
        unset($this->container[$key]);
    }

    /**
     * Sets all data in the row from an array
     *
     * @param  array $data
     *
     * @return void
     */
    public function setFromArray(array $data): void
    {
        foreach ($data as $key => $value) {
            $this->container[$key] = $value;
        }
    }

    /**
     * Returns the column/value data as an array
     *
     * @return array
     */
    public function toArray(): array
    {
        return $this->container;
    }

    /**
     * Reset the container array
     *
     * @return void
     */
    public function resetArray(): void
    {
        foreach ($this->container as &$value) {
            $value = null;
        }
    }
}