ReflectionAnnotatedClass::getAnnotation() - Code Metrics - Maslosoft/Addendum - Measure and Improve Code Quality continuously with Scrutinizer

ReflectionAnnotatedClass::getAnnotation() A
last analyzed 2020-02-26 13:32 UTC

↳ Parent: ReflectionAnnotatedClass

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	1

<?php

/**
 * This software package is licensed under AGPL, Commercial license.
 *
 * @package maslosoft/addendum
 * @licence AGPL, Commercial
 * @copyright Copyright (c) Piotr Masełkowski <[email protected]> (Meta container, further improvements, bugfixes)
 * @copyright Copyright (c) Maslosoft (Meta container, further improvements, bugfixes)
 * @copyright Copyright (c) Jan Suchal (Original version, builder, parser)
 * @link https://maslosoft.com/addendum/ - maslosoft addendum
 * @link https://code.google.com/p/addendum/ - original addendum project
 */

namespace Maslosoft\Addendum\Reflection;

use Maslosoft\Addendum\Addendum;
use Maslosoft\Addendum\Builder\Builder;
use Maslosoft\Addendum\Collections\AnnotationsCollection;
use Maslosoft\Addendum\Interfaces\AnnotatedReflectorInterface;
use Maslosoft\Addendum\Utilities\ConflictChecker;
use ReflectionClass;

class ReflectionAnnotatedClass extends ReflectionClass implements AnnotatedReflectorInterface
{

	/**
	 * Annotations collection
	 * @var AnnotationsCollection
	 */
	private $annotations = null;

	/**
	 * Addendum instance
	 * @var Addendum
	 */
	private $addendum = null;

	public function __construct($class, Addendum $addendum = null)
	{
		parent::__construct($class);
		$this->annotations = (new Builder($addendum))->build($this);
		$this->addendum = $addendum;
		ConflictChecker::check($this, $this->annotations);
	}

	public function hasAnnotation($class)
	{
		return $this->annotations->hasAnnotation($class);
	}

	public function getAnnotation($annotation)
	{
		return $this->annotations->getAnnotation($annotation);
	}

	public function getAnnotations()
	{
		return $this->annotations->getAnnotations();
	}

	public function getAllAnnotations($restriction = false)
	{
		return $this->annotations->getAllAnnotations($restriction);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
	}

	public function getConstructor()
	{
		return $this->createReflectionAnnotatedMethod(parent::getConstructor());
	}

	public function getMethod($name)
	{
		return $this->createReflectionAnnotatedMethod(parent::getMethod($name));
	}

	public function getMethods($filter = -1)
	{
		$result = [];
		foreach (parent::getMethods($filter) as $method)
		{
			$result[] = $this->createReflectionAnnotatedMethod($method);
		}
		return $result;
	}

	public function getProperty($name)
	{
		return $this->createReflectionAnnotatedProperty(parent::getProperty($name));
	}

	public function getProperties($filter = -1)
	{
		$result = [];
		foreach (parent::getProperties($filter) as $property)
		{
			$result[] = $this->createReflectionAnnotatedProperty($property);
		}
		return $result;
	}

	public function getInterfaces()
	{
		$result = [];
		foreach (parent::getInterfaces() as $interface)
		{
			$result[] = $this->createReflectionAnnotatedClass($interface);
		}
		return $result;
	}

	public function getParentClass()
	{
		$class = parent::getParentClass();
		return $this->createReflectionAnnotatedClass($class);

	}

	private function createReflectionAnnotatedClass($class)
	{
		return ($class !== false) ? new ReflectionAnnotatedClass($class->name, $this->addendum) : false;
	}

	private function createReflectionAnnotatedMethod($method)
	{
		return ($method !== null) ? new ReflectionAnnotatedMethod($this->name, $method->name, $this->addendum) : null;
	}

	private function createReflectionAnnotatedProperty($property)
	{
		return ($property !== null) ? new ReflectionAnnotatedProperty($this->name, $property->name, $this->addendum) : null;
	}

}


1		<?php
2
3		/**
4		* This software package is licensed under AGPL, Commercial license.
5		*
6		* @package maslosoft/addendum
7		* @licence AGPL, Commercial
8		* @copyright Copyright (c) Piotr Masełkowski <[email protected]> (Meta container, further improvements, bugfixes)
9		* @copyright Copyright (c) Maslosoft (Meta container, further improvements, bugfixes)
10		* @copyright Copyright (c) Jan Suchal (Original version, builder, parser)
11		* @link https://maslosoft.com/addendum/ - maslosoft addendum
12		* @link https://code.google.com/p/addendum/ - original addendum project
13		*/
14
15		namespace Maslosoft\Addendum\Reflection;
16
17		use Maslosoft\Addendum\Addendum;
18		use Maslosoft\Addendum\Builder\Builder;
19		use Maslosoft\Addendum\Collections\AnnotationsCollection;
20		use Maslosoft\Addendum\Interfaces\AnnotatedReflectorInterface;
21		use Maslosoft\Addendum\Utilities\ConflictChecker;
22		use ReflectionClass;
23
24		class ReflectionAnnotatedClass extends ReflectionClass implements AnnotatedReflectorInterface
25		{
26
27		/**
28		* Annotations collection
29		* @var AnnotationsCollection
30		*/
31		private $annotations = null;
32
33		/**
34		* Addendum instance
35		* @var Addendum
36		*/
37		private $addendum = null;
38
39	58	public function __construct($class, Addendum $addendum = null)
40		{
41	58	parent::__construct($class);
42	58	$this->annotations = (new Builder($addendum))->build($this);
43	58	$this->addendum = $addendum;
44	58	ConflictChecker::check($this, $this->annotations);
45	58	}
46
47	55	public function hasAnnotation($class)
48		{
49	55	return $this->annotations->hasAnnotation($class);
50		}
51
52	16	public function getAnnotation($annotation)
53		{
54	16	return $this->annotations->getAnnotation($annotation);
55		}
56
57		public function getAnnotations()
58		{
59		return $this->annotations->getAnnotations();
60		}
61
62	31	public function getAllAnnotations($restriction = false)
63		{
64	31	return $this->annotations->getAllAnnotations($restriction);
		0 ignored issues – show Documentation introduced 2015-12-16 15:41 UTC by Report Bug Copy Issue Report `$restriction` is of type `boolean`, but the function expects a `false\|string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
65		}
66
67		public function getConstructor()
68		{
69		return $this->createReflectionAnnotatedMethod(parent::getConstructor());
70		}
71
72	4	public function getMethod($name)
73		{
74	4	return $this->createReflectionAnnotatedMethod(parent::getMethod($name));
75		}
76
77	30	public function getMethods($filter = -1)
78		{
79	30	$result = [];
80	30	foreach (parent::getMethods($filter) as $method)
81		{
82	6	$result[] = $this->createReflectionAnnotatedMethod($method);
83		}
84	30	return $result;
85		}
86
87	3	public function getProperty($name)
88		{
89	3	return $this->createReflectionAnnotatedProperty(parent::getProperty($name));
90		}
91
92	32	public function getProperties($filter = -1)
93		{
94	32	$result = [];
95	32	foreach (parent::getProperties($filter) as $property)
96		{
97	19	$result[] = $this->createReflectionAnnotatedProperty($property);
98		}
99	30	return $result;
100		}
101
102	53	public function getInterfaces()
103		{
104	53	$result = [];
105	53	foreach (parent::getInterfaces() as $interface)
106		{
107	48	$result[] = $this->createReflectionAnnotatedClass($interface);
108		}
109	53	return $result;
110		}
111
112	53	public function getParentClass()
113		{
114	53	$class = parent::getParentClass();
115	53	return $this->createReflectionAnnotatedClass($class);
		0 ignored issues – show Comprehensibility Best Practice introduced 2016-03-10 10:49 UTC by Report Bug Copy Issue Report The expression `$this->createReflectionAnnotatedClass($class);` of type `Maslosoft\Addendum\Refle...ionAnnotatedClass\|false` adds `false` to the return on line 115 which is incompatible with the return type of the parent method `ReflectionClass::getParentClass` of type `object`. It seems like you forgot to handle an error condition. Loading history...
116		}
117
118	53	private function createReflectionAnnotatedClass($class)
119		{
120	53	return ($class !== false) ? new ReflectionAnnotatedClass($class->name, $this->addendum) : false;
121		}
122
123	9	private function createReflectionAnnotatedMethod($method)
124		{
125	9	return ($method !== null) ? new ReflectionAnnotatedMethod($this->name, $method->name, $this->addendum) : null;
126		}
127
128	21	private function createReflectionAnnotatedProperty($property)
129		{
130	21	return ($property !== null) ? new ReflectionAnnotatedProperty($this->name, $property->name, $this->addendum) : null;
131		}
132
133		}
134

Maslosoft / Addendum

ReflectionAnnotatedClass::getAnnotation() A last analyzed 2020-02-26 13:32 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ReflectionAnnotatedClass::getAnnotation() A
last analyzed 2020-02-26 13:32 UTC