AbstractDaftObject::CheckTypeDefinesOwnIdProperties() - Code Metrics - Inspection of "abstracting thingable exceptions" - SignpostMarv/daft-object - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a67098...e6e3d2 )

by SignpostMarv

created 2017-08-29 20:08 UTC

CheckTypeDefinesOwnIdProperties() C

↳ Parent: AbstractDaftObject

Complexity

Conditions	7
Paths	6

Size

Total Lines	51
Code Lines	33

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	51
rs	6.9743
c	0
b	0
f	0
cc	7
eloc	33
nc	6
nop	1

How to fix Long Method

<?php
/**
* Base daft objects.
*
* @author SignpostMarv
*/
declare(strict_types=1);

namespace SignpostMarv\DaftObject;

use TypeError;

/**
* Base daft object.
*/
abstract class AbstractDaftObject implements DaftObject
{
    /**
    * List of properties that can be defined on an implementation.
    *
    * @var string[]
    */
    const PROPERTIES = [];

    /**
    * List of nullable properties that can be defined on an implementation.
    *
    * @var string[]
    */
    const NULLABLE_PROPERTIES = [];

    /**
    * Index of checked types.
    *
    * @see self::CheckTypeDefinesOwnIdProperties()
    *
    * @var bool[]
    */
    private static $checkedTypes = [];

    /**
    * Does some sanity checking.
    *
    * @see DefinesOwnIdPropertiesInterface
    * @see self::CheckTypeDefinesOwnIdProperties()
    *
    * @throws TypeError if static::class was previously determined to be incorrectly implemented
    */
    public function __construct()
    {
        if (
            ($this instanceof DefinesOwnIdPropertiesInterface) &&
            self::CheckTypeDefinesOwnIdProperties($this) === false
        ) {
            throw new IncorrectlyImplementedTypeError(
                get_class($this) . // phpunit coverage does not pick up static::class here

                ' already determined to be incorrectly implemented'
            );
        }
    }

    /**
    * Maps param $property to the getter method.
    *
    * @param string $property the property being retrieved
    *
    * @throws UndefinedPropertyException if a property is undefined
    *
    * @return mixed
    */
    public function __get(string $property)

    {
        $expectedMethod = 'Get' . ucfirst($property);
        if (method_exists($this, $expectedMethod) !== true) {
            throw new UndefinedPropertyException(static::class, $property);
        }

        return $this->$expectedMethod();
    }

    /**
    * Maps param $property to the getter method.
    *
    * @param string $property the property being retrieved
    * @param mixed $v
    *
    * @throws UndefinedPropertyException if a property is undefined
    *
    * @return mixed
    */
    public function __set(string $property, $v)

    {
        $expectedMethod = 'Set' . ucfirst($property);
        if (
            method_exists($this, $expectedMethod) !== true
        ) {
            throw new PropertyNotWriteableException(static::class, $property);
        }

        return $this->$expectedMethod($v);
    }

    /**
    * required to support unset($foo->bar).
    *
    * @param string $property the property being unset
    *
    * @see static::NudgePropertyValue()
    */
    public function __unset(string $property) : void
    {
        $this->NudgePropertyValue($property, null);
    }

    /**
    * List of properties that can be defined on an implementation.
    *
    * @return string[]
    */
    final public static function DaftObjectProperties() : array
    {
        return static::PROPERTIES;
    }

    /**
    * List of nullable properties that can be defined on an implementation.
    *
    * @return string[]
    */
    final public static function DaftObjectNullableProperties() : array
    {
        return static::NULLABLE_PROPERTIES;
    }

    /**
    * Nudge the state of a given property, marking it as dirty.
    *
    * @param string $property property being nudged
    * @param mixed $value value to nudge property with
    *
    * @throws UndefinedPropertyException if $property is not in static::DaftObjectProperties()
    * @throws PropertyNotNullableException if $property is not in static::DaftObjectNullableProperties()
    */
    abstract protected function NudgePropertyValue(
        string $property,
        $value
    ) : void;

    /**
    * Checks if a type correctly defines it's own id.
    *
    * @param DaftObject $object
    *
    * @throws TypeError if $object::DaftObjectIdProperties() does not contain at least one property
    * @throws TypeError if $object::DaftObjectIdProperties() is not string[]
    * @throws UndefinedPropertyException if an id property is not in $object::DaftObjectIdProperties()
    */
    final protected static function CheckTypeDefinesOwnIdProperties(
        DaftObject $object
    ) : bool {
        static $checkedTypes = [];

        if (isset($checkedTypes[get_class($object)]) === false) {
            $checkedTypes[get_class($object)] = false;

            if (($object instanceof DefinesOwnIdPropertiesInterface) === false) {
                throw new IncorrectlyImplementedTypeError(
                    get_class($object) .

                    ' does not implement ' .
                    DefinesOwnIdPropertiesInterface::class
                );
            }

            $properties = $object::DaftObjectIdProperties();

            if (count($properties) < 1) {
                throw new IncorrectlyImplementedTypeError(
                    get_class($object) .

                    '::DaftObjectIdProperties() must return at least one' .
                    ' property'
                );
            }

            foreach ($properties as $property) {
                if (is_string($property) === false) {
                    throw new IncorrectlyImplementedTypeError(
                        get_class($object) .

                        '::DaftObjectIdProperties() does not return string[]'
                    );
                } elseif (
                    in_array(
                        $property,
                        $object::DaftObjectProperties(),
                        true
                    ) === false
                ) {
                    throw new UndefinedPropertyException(
                        get_class($object),
                        $property
                    );
                }
            }

            $checkedTypes[get_class($object)] = true;
        }

        return $checkedTypes[get_class($object)];
    }
}


1		<?php
2		/**
3		* Base daft objects.
4		*
5		* @author SignpostMarv
6		*/
7		declare(strict_types=1);
8
9		namespace SignpostMarv\DaftObject;
10
11		use TypeError;
12
13		/**
14		* Base daft object.
15		*/
16		abstract class AbstractDaftObject implements DaftObject
17		{
18		/**
19		* List of properties that can be defined on an implementation.
20		*
21		* @var string[]
22		*/
23		const PROPERTIES = [];
24
25		/**
26		* List of nullable properties that can be defined on an implementation.
27		*
28		* @var string[]
29		*/
30		const NULLABLE_PROPERTIES = [];
31
32		/**
33		* Index of checked types.
34		*
35		* @see self::CheckTypeDefinesOwnIdProperties()
36		*
37		* @var bool[]
38		*/
39		private static $checkedTypes = [];
40
41		/**
42		* Does some sanity checking.
43		*
44		* @see DefinesOwnIdPropertiesInterface
45		* @see self::CheckTypeDefinesOwnIdProperties()
46		*
47		* @throws TypeError if static::class was previously determined to be incorrectly implemented
48		*/
49		public function __construct()
50		{
51		if (
52		($this instanceof DefinesOwnIdPropertiesInterface) &&
53		self::CheckTypeDefinesOwnIdProperties($this) === false
54		) {
55		throw new IncorrectlyImplementedTypeError(
56		get_class($this) . // phpunit coverage does not pick up static::class here
		0 ignored issues – show Unused Code introduced 2017-08-29 19:48 UTC by Report Bug Copy Issue Report The call to `IncorrectlyImplementedTypeError::__construct()` has too many arguments starting with `get_class($this) . ' alr...ncorrectly implemented'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
57		' already determined to be incorrectly implemented'
58		);
59		}
60		}
61
62		/**
63		* Maps param $property to the getter method.
64		*
65		* @param string $property the property being retrieved
66		*
67		* @throws UndefinedPropertyException if a property is undefined
68		*
69		* @return mixed
70		*/
71	View Code Duplication	public function __get(string $property)
		1 ignored issue – show Duplication introduced 2017-08-29 19:48 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
72		{
73		$expectedMethod = 'Get' . ucfirst($property);
74		if (method_exists($this, $expectedMethod) !== true) {
75		throw new UndefinedPropertyException(static::class, $property);
76		}
77
78		return $this->$expectedMethod();
79		}
80
81		/**
82		* Maps param $property to the getter method.
83		*
84		* @param string $property the property being retrieved
85		* @param mixed $v
86		*
87		* @throws UndefinedPropertyException if a property is undefined
88		*
89		* @return mixed
90		*/
91	View Code Duplication	public function __set(string $property, $v)
		1 ignored issue – show Duplication introduced 2017-08-29 19:48 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
92		{
93		$expectedMethod = 'Set' . ucfirst($property);
94		if (
95		method_exists($this, $expectedMethod) !== true
96		) {
97		throw new PropertyNotWriteableException(static::class, $property);
98		}
99
100		return $this->$expectedMethod($v);
101		}
102
103		/**
104		* required to support unset($foo->bar).
105		*
106		* @param string $property the property being unset
107		*
108		* @see static::NudgePropertyValue()
109		*/
110		public function __unset(string $property) : void
111		{
112		$this->NudgePropertyValue($property, null);
113		}
114
115		/**
116		* List of properties that can be defined on an implementation.
117		*
118		* @return string[]
119		*/
120		final public static function DaftObjectProperties() : array
121		{
122		return static::PROPERTIES;
123		}
124
125		/**
126		* List of nullable properties that can be defined on an implementation.
127		*
128		* @return string[]
129		*/
130		final public static function DaftObjectNullableProperties() : array
131		{
132		return static::NULLABLE_PROPERTIES;
133		}
134
135		/**
136		* Nudge the state of a given property, marking it as dirty.
137		*
138		* @param string $property property being nudged
139		* @param mixed $value value to nudge property with
140		*
141		* @throws UndefinedPropertyException if $property is not in static::DaftObjectProperties()
142		* @throws PropertyNotNullableException if $property is not in static::DaftObjectNullableProperties()
143		*/
144		abstract protected function NudgePropertyValue(
145		string $property,
146		$value
147		) : void;
148
149		/**
150		* Checks if a type correctly defines it's own id.
151		*
152		* @param DaftObject $object
153		*
154		* @throws TypeError if $object::DaftObjectIdProperties() does not contain at least one property
155		* @throws TypeError if $object::DaftObjectIdProperties() is not string[]
156		* @throws UndefinedPropertyException if an id property is not in $object::DaftObjectIdProperties()
157		*/
158		final protected static function CheckTypeDefinesOwnIdProperties(
159		DaftObject $object
160		) : bool {
161		static $checkedTypes = [];
162
163		if (isset($checkedTypes[get_class($object)]) === false) {
164		$checkedTypes[get_class($object)] = false;
165
166		if (($object instanceof DefinesOwnIdPropertiesInterface) === false) {
167		throw new IncorrectlyImplementedTypeError(
168		get_class($object) .
		0 ignored issues – show Unused Code introduced 2017-08-29 19:48 UTC by Report Bug Copy Issue Report The call to `IncorrectlyImplementedTypeError::__construct()` has too many arguments starting with `get_class($object) . ' d...pertiesInterface::class`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
169		' does not implement ' .
170		DefinesOwnIdPropertiesInterface::class
171		);
172		}
173
174		$properties = $object::DaftObjectIdProperties();
175
176		if (count($properties) < 1) {
177		throw new IncorrectlyImplementedTypeError(
178		get_class($object) .
		0 ignored issues – show Unused Code introduced 2017-08-29 19:48 UTC by Report Bug Copy Issue Report The call to `IncorrectlyImplementedTypeError::__construct()` has too many arguments starting with `get_class($object) . '::...east one' . ' property'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
179		'::DaftObjectIdProperties() must return at least one' .
180		' property'
181		);
182		}
183
184		foreach ($properties as $property) {
185		if (is_string($property) === false) {
186		throw new IncorrectlyImplementedTypeError(
187		get_class($object) .
		0 ignored issues – show Unused Code introduced 2017-08-29 19:48 UTC by Report Bug Copy Issue Report The call to `IncorrectlyImplementedTypeError::__construct()` has too many arguments starting with `get_class($object) . '::...es not return string[]'`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
188		'::DaftObjectIdProperties() does not return string[]'
189		);
190		} elseif (
191		in_array(
192		$property,
193		$object::DaftObjectProperties(),
194		true
195		) === false
196		) {
197		throw new UndefinedPropertyException(
198		get_class($object),
199		$property
200		);
201		}
202		}
203
204		$checkedTypes[get_class($object)] = true;
205		}
206
207		return $checkedTypes[get_class($object)];
208		}
209		}
210

SignpostMarv / daft-object

GitHub Access Token became invalid

Push — master ( a67098...e6e3d2 )

CheckTypeDefinesOwnIdProperties() C

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like