Reflexion::getAnnotationMethod() - Code Metrics - Inspection of "update default view index" - phpMv/ubiquity - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( b68a78...d29a76 )

by Jean-Christophe

created 2020-12-30 13:34 UTC

Reflexion::getAnnotationMethod() A

↳ Parent: Reflexion

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

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

<?php

namespace Ubiquity\orm\parser;

use Ubiquity\orm\OrmUtils;
use Ubiquity\cache\CacheManager;
use Ubiquity\annotations\AnnotationsEngineInterface;

/**
 * Reflection utilities
 * in dev environment only
 *
 * @author jcheron <[email protected]>
 * @version 1.0.4
 *
 */
class Reflexion {
	use ReflexionFieldsTrait;
	protected static $classProperties = [ ];

	public static function getMethods($instance, $filter = null) {
		$reflect = new \ReflectionClass ( $instance );
		$methods = $reflect->getMethods ( $filter );
		return $methods;
	}

	public static function getKeyFields($instance) {
		return self::getMembersNameWithAnnotation ( \get_class ( $instance ), 'id' );
	}

	public static function getMemberValue($instance, $member) {
		$prop = self::getProperty ( $instance, $member );
		$prop->setAccessible ( true );
		return $prop->getValue ( $instance );
	}

	public static function getPropValue($instance, $prop) {
		return $prop->getValue ( $instance );
	}

	public static function setMemberValue($instance, $member, $value) {
		$prop = self::getProperty ( $instance, $member );
		if ($prop) {
			$prop->setAccessible ( true );
			$prop->setValue ( $instance, $value );
			return true;
		}
		return false;
	}

	public static function getPropertiesAndValues($instance, $props = NULL) {
		$ret = [];
		$className = \get_class ( $instance );
		$modelMetas = OrmUtils::getModelMetadata ( $className );
		if (isset ( self::$classProperties [$className] )) {
			foreach ( self::$classProperties [$className] as $name => $prop ) {
				$ret [$name] = $prop->getValue ( $instance );
			}
			return $ret;
		}
		if (\is_null ( $props ))
			$props = self::getProperties ( $instance );
		foreach ( $props as $prop ) {
			$prop->setAccessible ( true );
			$v = $prop->getValue ( $instance );
			if (\array_search ( $prop->getName (), $modelMetas ['#notSerializable'] ) === false) {
				if (OrmUtils::isNotNullOrNullAccepted ( $v, $className, $prop->getName () )) {
					$name = $modelMetas ['#fieldNames'] [$prop->getName ()] ?? $prop->getName ();
					$ret [$name] = $v;
					self::$classProperties [$className] [$name] = $prop;
				}
			}
		}
		return $ret;
	}

	/**
	 * Returns the annotation engine (php8 attributes or php annotations).
	 *
	 * @return AnnotationsEngineInterface
	 * @since 2.4.0
	 */
	public static function getAnnotsEngine(){
		return CacheManager::getAnnotationsEngineInstance();
	}

	public static function getAnnotationClass($class, $annotation) {
		$annot = self::getAnnotsEngine()->getAnnotsOfClass( $class, $annotation );
		return $annot;
	}

	public static function getAnnotationMember($class, $member, $annotation) {
		$annot = self::getAnnotsEngine()->getAnnotsOfProperty( $class, $member, $annotation );
		return \current ( $annot );
	}

	public static function getAnnotationMethod($class, $method, $annotation) {
		$annot = self::getAnnotsEngine()->getAnnotsOfMethod( $class, $method, $annotation );
		return \current ( $annot );
	}

	public static function getAnnotationsMember($class, $member, $annotation) {
		return self::getAnnotsEngine()->getAnnotsOfProperty ( $class, $member, $annotation );
	}

	public static function getAnnotationsMethod($class, $method, $annotation) {
		$annotsEngine=self::getAnnotsEngine();
		if (\is_array ( $annotation )) {
			$result = [ ];
			foreach ( $annotation as $annot ) {
				$annots = $annotsEngine->getAnnotsOfMethod( $class, $method, $annot );
				if (\count ( $annots ) > 0) {
					$result = \array_merge ( $result, $annots );
				}
			}
			return $result;
		}
		$annots = $annotsEngine->getAnnotsOfMethod ( $class, $method, $annotation );
		if (\count ( $annots ) > 0){
			return $annots;
		}
		return false;
	}

	public static function getMembersAnnotationWithAnnotation($class, $annotation) {
		return self::getMembersWithAnnotation_ ( $class, $annotation, function (&$ret, $prop, $annot) {
			$ret [$prop->getName ()] = $annot;
		} );
	}

	public static function getMembersWithAnnotation($class, $annotation) {
		return self::getMembersWithAnnotation_ ( $class, $annotation, function (&$ret, $prop) {
			$ret [] = $prop;
		} );
	}

	public static function getMembersNameWithAnnotation($class, $annotation) {
		return self::getMembersWithAnnotation_ ( $class, $annotation, function (&$ret, $prop) {
			$ret [] = $prop->getName ();
		} );
	}

	protected static function getMembersWithAnnotation_($class, $annotation, $callback) {
		$props = self::getProperties ( $class );
		$ret = array ();
		foreach ( $props as $prop ) {
			$annot = self::getAnnotationMember ( $class, $prop->getName (), $annotation );
			if ($annot !== false)
				$callback ( $ret, $prop, $annot );
		}
		return $ret;
	}

	public static function getTableName($class) {
		$ret = self::getAnnotationClass ( $class, 'table' );
		if (\count ( $ret ) === 0) {
			$posSlash = \strrpos ( $class, '\\' );
			if ($posSlash !== false)
				$class = \substr ( $class, $posSlash + 1 );
			$ret = $class;
		} else {
			$ret = $ret [0]->name;
		}
		return $ret;
	}

	public static function getMethodParameters(\ReflectionFunctionAbstract $method) {
		$result = array ();
		foreach ( $method->getParameters () as $param ) {
			$result [] = $param->name;
		}
		return $result;
	}

	public static function getJoinTables($class) {
		$result = [ ];
		$annots = self::getMembersAnnotationWithAnnotation ( $class, 'joinTable' );
		foreach ( $annots as $annot ) {
			$result [] = $annot->name;
		}
		return $result;
	}

	public static function getAllJoinTables($models) {
		$result = [ ];
		foreach ( $models as $model ) {
			$result = array_merge ( $result, self::getJoinTables ( $model ) );
		}
		return $result;
	}
}


1		<?php
2
3		namespace Ubiquity\orm\parser;
4
5		use Ubiquity\orm\OrmUtils;
6		use Ubiquity\cache\CacheManager;
7		use Ubiquity\annotations\AnnotationsEngineInterface;
8
9		/**
10		* Reflection utilities
11		* in dev environment only
12		*
13		* @author jcheron <[email protected]>
14		* @version 1.0.4
15		*
16		*/
17		class Reflexion {
18		use ReflexionFieldsTrait;
19		protected static $classProperties = [ ];
20
21	17	public static function getMethods($instance, $filter = null) {
22	17	$reflect = new \ReflectionClass ( $instance );
23	17	$methods = $reflect->getMethods ( $filter );
24	17	return $methods;
25		}
26
27	48	public static function getKeyFields($instance) {
28	48	return self::getMembersNameWithAnnotation ( \get_class ( $instance ), 'id' );
29		}
30
31	34	public static function getMemberValue($instance, $member) {
32	34	$prop = self::getProperty ( $instance, $member );
33	34	$prop->setAccessible ( true );
34	34	return $prop->getValue ( $instance );
35		}
36
37	57	public static function getPropValue($instance, $prop) {
38	57	return $prop->getValue ( $instance );
39		}
40
41	1	public static function setMemberValue($instance, $member, $value) {
42	1	$prop = self::getProperty ( $instance, $member );
43	1	if ($prop) {
44		$prop->setAccessible ( true );
45		$prop->setValue ( $instance, $value );
46		return true;
47		}
48	1	return false;
49		}
50
51	23	public static function getPropertiesAndValues($instance, $props = NULL) {
52	23	$ret = [];
53	23	$className = \get_class ( $instance );
54	23	$modelMetas = OrmUtils::getModelMetadata ( $className );
55	23	if (isset ( self::$classProperties [$className] )) {
56	17	foreach ( self::$classProperties [$className] as $name => $prop ) {
57	17	$ret [$name] = $prop->getValue ( $instance );
58		}
59	17	return $ret;
60		}
61	7	if (\is_null ( $props ))
62	7	$props = self::getProperties ( $instance );
63	7	foreach ( $props as $prop ) {
64	7	$prop->setAccessible ( true );
65	7	$v = $prop->getValue ( $instance );
66	7	if (\array_search ( $prop->getName (), $modelMetas ['#notSerializable'] ) === false) {
67	7	if (OrmUtils::isNotNullOrNullAccepted ( $v, $className, $prop->getName () )) {
68	7	$name = $modelMetas ['#fieldNames'] [$prop->getName ()] ?? $prop->getName ();
69	7	$ret [$name] = $v;
70	7	self::$classProperties [$className] [$name] = $prop;
71		}
72		}
73		}
74	7	return $ret;
75		}
76
77		/**
78		* Returns the annotation engine (php8 attributes or php annotations).
79		*
80		* @return AnnotationsEngineInterface
81		* @since 2.4.0
82		*/
83	55	public static function getAnnotsEngine(){
84	55	return CacheManager::getAnnotationsEngineInstance();
85		}
86
87	52	public static function getAnnotationClass($class, $annotation) {
88	52	$annot = self::getAnnotsEngine()->getAnnotsOfClass( $class, $annotation );
89	52	return $annot;
90		}
91
92	49	public static function getAnnotationMember($class, $member, $annotation) {
93	49	$annot = self::getAnnotsEngine()->getAnnotsOfProperty( $class, $member, $annotation );
94	49	return \current ( $annot );
95		}
96
97		public static function getAnnotationMethod($class, $method, $annotation) {
98		$annot = self::getAnnotsEngine()->getAnnotsOfMethod( $class, $method, $annotation );
99		return \current ( $annot );
100		}
101
102	38	public static function getAnnotationsMember($class, $member, $annotation) {
103	38	return self::getAnnotsEngine()->getAnnotsOfProperty ( $class, $member, $annotation );
104		}
105
106	17	public static function getAnnotationsMethod($class, $method, $annotation) {
107	17	$annotsEngine=self::getAnnotsEngine();
108	17	if (\is_array ( $annotation )) {
109	17	$result = [ ];
110	17	foreach ( $annotation as $annot ) {
111	17	$annots = $annotsEngine->getAnnotsOfMethod( $class, $method, $annot );
112	17	if (\count ( $annots ) > 0) {
113	17	$result = \array_merge ( $result, $annots );
114		}
115		}
116	17	return $result;
117		}
118	6	$annots = $annotsEngine->getAnnotsOfMethod ( $class, $method, $annotation );
119	6	if (\count ( $annots ) > 0){
120	6	return $annots;
121		}
122	6	return false;
123		}
124
125	48	public static function getMembersAnnotationWithAnnotation($class, $annotation) {
126		return self::getMembersWithAnnotation_ ( $class, $annotation, function (&$ret, $prop, $annot) {
127	48	$ret [$prop->getName ()] = $annot;
128	48	} );
129		}
130
131		public static function getMembersWithAnnotation($class, $annotation) {
132		return self::getMembersWithAnnotation_ ( $class, $annotation, function (&$ret, $prop) {
133		$ret [] = $prop;
134		} );
135		}
136
137	48	public static function getMembersNameWithAnnotation($class, $annotation) {
138		return self::getMembersWithAnnotation_ ( $class, $annotation, function (&$ret, $prop) {
139	48	$ret [] = $prop->getName ();
140	48	} );
141		}
142
143	48	protected static function getMembersWithAnnotation_($class, $annotation, $callback) {
144	48	$props = self::getProperties ( $class );
145	48	$ret = array ();
146	48	foreach ( $props as $prop ) {
147	48	$annot = self::getAnnotationMember ( $class, $prop->getName (), $annotation );
148	48	if ($annot !== false)
149	48	$callback ( $ret, $prop, $annot );
150		}
151	48	return $ret;
152		}
153
154	48	public static function getTableName($class) {
155	48	$ret = self::getAnnotationClass ( $class, 'table' );
156	48	if (\count ( $ret ) === 0) {
157	48	$posSlash = \strrpos ( $class, '\\' );
158	48	if ($posSlash !== false)
159	48	$class = \substr ( $class, $posSlash + 1 );
160	48	$ret = $class;
161		} else {
162	47	$ret = $ret [0]->name;
163		}
164	48	return $ret;
165		}
166
167	17	public static function getMethodParameters(\ReflectionFunctionAbstract $method) {
168	17	$result = array ();
169	17	foreach ( $method->getParameters () as $param ) {
170	17	$result [] = $param->name;
171		}
172	17	return $result;
173		}
174
175	2	public static function getJoinTables($class) {
176	2	$result = [ ];
177	2	$annots = self::getMembersAnnotationWithAnnotation ( $class, 'joinTable' );
178	2	foreach ( $annots as $annot ) {
179	2	$result [] = $annot->name;
180		}
181	2	return $result;
182		}
183
184	2	public static function getAllJoinTables($models) {
185	2	$result = [ ];
186	2	foreach ( $models as $model ) {
187	2	$result = array_merge ( $result, self::getJoinTables ( $model ) );
188		}
189	2	return $result;
190		}
191		}
192

phpMv / ubiquity

Push — master ( b68a78...d29a76 )

Reflexion::getAnnotationMethod() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like