Suricate\Traits\DBObjectProtected

Complexity

Total Complexity

11

Size/Duplication

Total Lines	66
Duplicated Lines	0 %

Test Coverage

Coverage

84.21%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	accessToProtectedVariable()	0	3	1
A	isProtectedVariable()	0	3	1
A	isProtectedVariableLoaded()	0	3	1
A	getProtectedVariable()	0	18	6
A	markProtectedVariableAsLoaded()	0	7	2

<?php declare(strict_types=1);
namespace Suricate\Traits;

use Suricate\DBObject;

trait DBObjectProtected
{
    protected $protectedVariables           = [];
    protected $protectedValues              = [];
    protected $loadedProtectedVariables     = [];

    /**
     * @param string $name
     */
    private function getProtectedVariable(string $name)
    {
        // Variable exists, and is already loaded
        if (isset($this->protectedValues[$name]) && $this->isProtectedVariableLoaded($name)) {
            return $this->protectedValues[$name];
        }
        // Variable has not been loaded
        if (!$this->isProtectedVariableLoaded($name)) {
            if ($this->accessToProtectedVariable($name)) {
                $this->markProtectedVariableAsLoaded($name);
            }
        }

        if (isset($this->protectedValues[$name])) {
            return $this->protectedValues[$name];
        }

        return null;
    }
    /**
     * Mark a protected variable as loaded
     * @param  string $name varialbe name
     *
     * @return DBObject
     */
    public function markProtectedVariableAsLoaded(string $name)
    {
        if ($this->isProtectedVariable($name)) {
            $this->loadedProtectedVariables[$name] = true;
        }

        return $this;
    }

    /**
    * Check if variable is a protected variable
    * @param  string  $name variable name
    * @return boolean
    */
    public function isProtectedVariable(string $name): bool
    {
        return in_array($name, $this->protectedVariables);
    }

    /**
     * Check if a protected variable already have been loaded
     * @param  string  $name Variable name
     * @return boolean
     */
    protected function isProtectedVariableLoaded(string $name): bool
    {
        return isset($this->loadedProtectedVariables[$name]);
    }

    protected function accessToProtectedVariable(string $name): bool

The parameter $name is not used and could be removed.

    {
        return false;
    }
}