Woo\GridView\Traits\Configurable

Complexity

Total Complexity

16

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	loadConfig()	0	11	3
	configTests()	0	1	?
C	testConfig()	0	57	13

<?php

namespace Woo\GridView\Traits;

use Closure;
use Woo\GridView\Exceptions\GridViewConfigException;

trait Configurable
{
    /**
     * Allows to load config into object properties
     * @param array $config
     * @throws GridViewConfigException
     */
    public function loadConfig(array $config)
    {
        foreach ($config as $key => $value) {

            if (property_exists($this, $key)) {
                $this->$key = $value;
            }
        }

        $this->testConfig();
    }

    /**
     * Should specify tests
     * @return array
     */
    abstract protected function configTests() : array;

    /**
     * Allows to test attributes and types in config
     * @throws GridViewConfigException
     */
    protected function testConfig()
    {
        foreach ($this->configTests() as $property => $tests) {

            if (!property_exists($this, $property)) {
                throw new GridViewConfigException(
                    'Unable to test ' . get_class($this) . ': property ' . $property . ' does not exist'
                );
            }

            $testPassed = true;
            $testMessage = 'Validation failed';

            foreach (explode('|', $tests) as $test) {

                switch ($test) {
                    case 'int':
                        $testPassed = is_numeric($this->$property);
                        $testMessage = 'Property should be numeric';
                        break;

                    case 'string':
                        $testPassed = is_string($this->$property);
                        $testMessage = 'Property should be a string';
                        break;

                    case 'array':
                        $testPassed = is_array($this->$property);
                        $testMessage = 'Property should be an array';
                        break;

                    case 'closure':
                        $testPassed = $this->$property instanceof Closure;
                        $testMessage = 'Property should be a valid callback (Closure instance)';
                        break;

                    case 'boolean':
                        $testPassed = is_bool($this->$property);
                        $testMessage = 'Property should be boolean';
                        break;

                    case 'any':
                        break;

                    default:
                        $testPassed = $testPassed || is_a($this->$property, $test) || is_subclass_of($this->$property, $test);

Due to PHP Bug #53727, is_subclass_of might return inconsistent results on some PHP versions if $test can be an interface. If so, you could instead use ReflectionClass::implementsInterface.

                        $testMessage = 'Property should be ' . $test . ' instance/class reference, got ' . print_r($this->$property, 1);
                }
            }

            if (!$testPassed) {
                throw new GridViewConfigException(
                    'Tests ' . $tests . ' has failed on ' . get_class($this) . '::' . $property . ': ' . $testMessage
                );
            }
        }
    }
}