HooksReader::read() - Code Metrics - Inspection of "Add method Annotations for Actions/Filters" - intraxia/jaxion - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#22)

by James

created 2019-11-23 20:36 UTC

HooksReader::read() A

↳ Parent: HooksReader

Complexity

Conditions	4
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	16
CRAP Score	4

Importance

Changes

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

<?php

namespace Intraxia\Jaxion\Core;

use Doctrine\Common\Annotations\AnnotationReader;
use Doctrine\Common\Annotations\AnnotationRegistry;
use ReflectionClass;

/**
 * HooksReader class.
 */
class HooksReader {

	/**
	 * Construct a new HooksReader instance.
	 */
	private function __construct() {
		$this->reader = new AnnotationReader();
class MyClass { }

$x = new MyClass();
$x->foo = true;
		AnnotationRegistry::registerFile(

			__DIR__ . '/Annotations.php'
		);
	}

	/**
	 * Get the Annotation reader.
	 *
	 * @return AnnotationReader
	 */
	private function reader() {
		return $this->reader;
	}

	/**
	 * Get the shared reader instance.
	 *
	 * @return HooksReader
	 */
	static private function instance() {
		static $instance;

		if ( ! $instance ) {
			$instance = new HooksReader();
		}

		return $instance;
	}

	/**
	 * Shared implementation of hook reading logic.
	 *
	 * @param  object   $target    Object to read annotations from.
	 * @param  \Closure $condition Whether the annotation should be registered.
	 * @return array
	 */
	static public function read( $target, $condition ) {
		$reader = static::instance()->reader();
class YourClass
{
    private static function getTemperature() {
        return "3422 °C";
}

public static function getSomeVariable()
{
    return static::getTemperature();
}
		$rmethods = (new ReflectionClass( $target ))->getMethods();

		$hooks = [];

		foreach ( $rmethods as $rmethod ) {
			foreach ( $reader->getMethodAnnotations( $rmethod ) as $annotation ) {
				if ( $condition( $annotation ) ) {
					$hooks[] = [
						'hook' => $annotation->hook,
						'method' => $rmethod->getName(),

						'priority' => $annotation->priority,
						'args' => $annotation->args,
					];
				}
			}
		}

		return $hooks;
	}
}


1		<?php
2
3		namespace Intraxia\Jaxion\Core;
4
5		use Doctrine\Common\Annotations\AnnotationReader;
6		use Doctrine\Common\Annotations\AnnotationRegistry;
7		use ReflectionClass;
8
9		/**
10		* HooksReader class.
11		*/
12		class HooksReader {
13
14		/**
15		* Construct a new HooksReader instance.
16		*/
17	3	private function __construct() {
18	3	$this->reader = new AnnotationReader();
		0 ignored issues – show Bug introduced 2019-11-23 20:40 UTC by Report Bug Copy Issue Report The property `reader` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
19	3	AnnotationRegistry::registerFile(
		0 ignored issues – show Deprecated Code introduced 2019-11-23 20:40 UTC by Report Bug Copy Issue Report The method `Doctrine\Common\Annotati...egistry::registerFile()` has been deprecated with message: this method is deprecated and will be removed in doctrine/annotations 2.0 autoloading should be deferred to the globally registered autoloader by then. For now, use @example AnnotationRegistry::registerLoader('class_exists') This method has been deprecated. The supplier of the class has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the method will be removed from the class and what other method or class to use instead. Loading history...
20	1	__DIR__ . '/Annotations.php'
21	2	);
22	3	}
23
24		/**
25		* Get the Annotation reader.
26		*
27		* @return AnnotationReader
28		*/
29	30	private function reader() {
30	30	return $this->reader;
31		}
32
33		/**
34		* Get the shared reader instance.
35		*
36		* @return HooksReader
37		*/
38	30	static private function instance() {
39	30	static $instance;
40
41	30	if ( ! $instance ) {
42	3	$instance = new HooksReader();
43	2	}
44
45	30	return $instance;
46		}
47
48		/**
49		* Shared implementation of hook reading logic.
50		*
51		* @param object $target Object to read annotations from.
52		* @param \Closure $condition Whether the annotation should be registered.
53		* @return array
54		*/
55	30	static public function read( $target, $condition ) {
56	30	$reader = static::instance()->reader();
		0 ignored issues – show Bug introduced 2019-11-23 20:40 UTC by Report Bug Copy Issue Report Since `instance()` is declared private, calling it with `static` will lead to errors in possible sub-classes. You can either use `self`, or increase the visibility of `instance()` to at least protected. Let’s assume you have a class which uses late-static binding: class YourClass { private static function getTemperature() { return "3422 °C"; } public static function getSomeVariable() { return static::getTemperature(); } } The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the `getSomeVariable()` on that sub-class, you will receive a runtime error: class YourSubClass extends YourClass { private static function getTemperature() { return "-182 °C"; } } print YourSubClass::getSomeVariable(); // Will cause an access error. In the case above, it makes sense to update `SomeClass` to use `self` instead: class YourClass { private static function getTemperature() { return "3422 °C"; } public static function getSomeVariable() { return self::getTemperature(); } } Loading history...
57	30	$rmethods = (new ReflectionClass( $target ))->getMethods();
58
59	30	$hooks = [];
60
61	30	foreach ( $rmethods as $rmethod ) {
62	30	foreach ( $reader->getMethodAnnotations( $rmethod ) as $annotation ) {
63	24	if ( $condition( $annotation ) ) {
64	24	$hooks[] = [
65	24	'hook' => $annotation->hook,
66	24	'method' => $rmethod->getName(),
		0 ignored issues – show Bug introduced 2019-11-23 20:40 UTC by Report Bug Copy Issue Report Consider using `$rmethod->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
67	24	'priority' => $annotation->priority,
68	24	'args' => $annotation->args,
69		];
70	16	}
71	16	}
72	16	}
73
74	24	return $hooks;
75		}
76		}
77

intraxia / jaxion

Pull Request — master (#22)

HooksReader::read() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like