EnumerationBase::isValid() - Code Metrics - Inspection of "*Added filed support to enumerations and a little..." - BuildrPHP/Utils - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ba55b5...96e451 )

by Zoltán

created 2016-04-18 14:24 UTC

EnumerationBase::isValid() A

↳ Parent: EnumerationBase

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	3
rs	10
cc	1
eloc	2
nc	1
nop	1

<?php namespace BuildR\Utils\Enumeration;

use \ReflectionClass;
use \Countable;
use BuildR\Foundation\Object\StringConvertibleInterface;
use BuildR\Utils\Enumeration\Exception\EnumerationException;

class EnumerationBase implements StringConvertibleInterface, Countable {

    public $value;

    private static $cache = [];

    public function __construct($value) {
        if(!$this->isValid($value)) {
            throw EnumerationException::invalidValue($value);
        }

        $this->value = $value;
    }

    public function isValid($value) {
        return (bool) in_array($value, self::toArray());
    }

    public function getValue() {
        return $this->value;
    }

    public static function toArray() {
        $enumClass = get_called_class();

        if(!array_key_exists($enumClass, self::$cache)) {
            $reflector = new ReflectionClass($enumClass);
            self::$cache[$enumClass] = $reflector->getConstants();
        }

        return self::$cache[$enumClass];
    }

    public static function getKeys() {
        return array_keys(self::toArray());
    }

    public static function isValidKey($key) {
        if(!is_string($key)) {
            throw EnumerationException::invalidKeyType(gettype($key));
        }

        return array_key_exists($key, self::toArray());
    }

    public static function __callStatic($name, $arguments) {

        $calledClass = get_called_class();
        $args[] = $name;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        if(array_key_exists(EnumerationFieldDefinitionInterface::class, class_implements($calledClass))) {
            $fields = static::defineFields()[$name];
            array_unshift($fields, $args[0]);

            $args = $fields;
        }

        $reflector = new ReflectionClass($calledClass);
        return $reflector->newInstanceArgs($args);
    }

    // ==========================================
    // StringConvertibleInterface implementation
    // ==========================================

    /**
     * {@inheritdoc}
     */
    public function __toString() {
        return $this->value;
    }

    /**
     * {@inheritdoc}
     */
    public function toString() {
        return $this->value;
    }

    // ===================================
    // Countable interface implementation
    // ===================================

    /**
     * {@inheritdoc}
     */
    public function count() {
        return count(self::toArray());
    }

}


1			<?php namespace BuildR\Utils\Enumeration;
2
3			use \ReflectionClass;
4			use \Countable;
5			use BuildR\Foundation\Object\StringConvertibleInterface;
6			use BuildR\Utils\Enumeration\Exception\EnumerationException;
7
8			class EnumerationBase implements StringConvertibleInterface, Countable {
9
10			public $value;
11
12			private static $cache = [];
13
14			public function __construct($value) {
15			if(!$this->isValid($value)) {
16			throw EnumerationException::invalidValue($value);
17			}
18
19			$this->value = $value;
20			}
21
22			public function isValid($value) {
23			return (bool) in_array($value, self::toArray());
24			}
25
26			public function getValue() {
27			return $this->value;
28			}
29
30			public static function toArray() {
31			$enumClass = get_called_class();
32
33			if(!array_key_exists($enumClass, self::$cache)) {
34			$reflector = new ReflectionClass($enumClass);
35			self::$cache[$enumClass] = $reflector->getConstants();
36			}
37
38			return self::$cache[$enumClass];
39			}
40
41			public static function getKeys() {
42			return array_keys(self::toArray());
43			}
44
45			public static function isValidKey($key) {
46			if(!is_string($key)) {
47			throw EnumerationException::invalidKeyType(gettype($key));
48			}
49
50			return array_key_exists($key, self::toArray());
51			}
52
53			public static function __callStatic($name, $arguments) {
			0 ignored issues – show Unused Code introduced 2016-04-18 14:27 UTC by Report Bug Copy Issue Report The parameter `$arguments` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
54			$calledClass = get_called_class();
55			$args[] = $name;
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-04-18 14:27 UTC by Report Bug Copy Issue Report `$args` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$args = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
56
57			if(array_key_exists(EnumerationFieldDefinitionInterface::class, class_implements($calledClass))) {
58			$fields = static::defineFields()[$name];
59			array_unshift($fields, $args[0]);
60
61			$args = $fields;
62			}
63
64			$reflector = new ReflectionClass($calledClass);
65			return $reflector->newInstanceArgs($args);
66			}
67
68			// ==========================================
69			// StringConvertibleInterface implementation
70			// ==========================================
71
72			/**
73			* {@inheritdoc}
74			*/
75			public function __toString() {
76			return $this->value;
77			}
78
79			/**
80			* {@inheritdoc}
81			*/
82			public function toString() {
83			return $this->value;
84			}
85
86			// ===================================
87			// Countable interface implementation
88			// ===================================
89
90			/**
91			* {@inheritdoc}
92			*/
93			public function count() {
94			return count(self::toArray());
95			}
96
97			}
98

BuildrPHP / Utils

Push — master ( ba55b5...96e451 )

EnumerationBase::isValid() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like