ExtendReaderWithConfigReader - Code Metrics - apie-lib/fake-annotations-plugin - Measure and Improve Code Quality continuously with Scrutinizer

ExtendReaderWithConfigReader A
last analyzed 2021-02-14 21:10 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	20
c	1
b	0
f	0
dl	0
loc	75
rs	10
wmc	10

7 Methods

Rating	Name	Size	Complexity
A	getPropertyAnnotation()	3	1
A	getMethodAnnotation()	3	1
A	getMethodAnnotations()	3	1
A	__construct()	4	1
A	getClassAnnotations()	12	2
A	getClassAnnotation()	7	3
A	getPropertyAnnotations()	3	1

<?php
namespace Apie\FakeAnnotationsPlugin\Readers;

use Apie\Core\Annotations\ApiResource;
use Doctrine\Common\Annotations\Reader;
use ReflectionClass;
use ReflectionMethod;
use ReflectionProperty;

/**
 * Extend the annotation reader with a config array to override the actual annotations if required. Should only
 * work on the ApiResource annotation.
 */
class ExtendReaderWithConfigReader implements Reader
{
    private $reader;

    private $config;

    /**
     * @param Reader $reader
     * @param ApiResource[] $config
     */
    public function __construct(Reader $reader, array $config)
    {
        $this->reader = $reader;
        $this->config = $config;
    }

    /**
     * {@inheritDoc}
     */
    public function getClassAnnotations(ReflectionClass $class)
    {
        $className = $class->getName();
        $annotations = $this->reader->getClassAnnotations($class);
        if (isset($this->config[$className])) {
            $annotations = array_filter($annotations, function ($annotation) {
                return !($annotation instanceof ApiResource);
            });
            $annotations[] = $this->config[$className];
        }

        return $annotations;
    }

    /**
     * {@inheritDoc}
     */
    public function getClassAnnotation(ReflectionClass $class, $annotationName)
    {
        $className = $class->getName();
        if ($annotationName === ApiResource::class && isset($this->config[$className])) {
            return $this->config[$className];
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
        }
        return $this->reader->getClassAnnotation($class, $annotationName);
    }

    /**
     * {@inheritDoc}
     */
    public function getMethodAnnotations(ReflectionMethod $method)
    {
        return $this->reader->getMethodAnnotations($method);
    }

    /**
     * {@inheritDoc}
     */
    public function getMethodAnnotation(ReflectionMethod $method, $annotationName)
    {
        return $this->reader->getMethodAnnotation($method, $annotationName);
    }

    /**
     * {@inheritDoc}
     */
    public function getPropertyAnnotations(ReflectionProperty $property)
    {
        return $this->reader->getPropertyAnnotations($property);
    }

    /**
     * {@inheritDoc}
     */
    public function getPropertyAnnotation(ReflectionProperty $property, $annotationName)
    {
        return $this->reader->getPropertyAnnotation($property, $annotationName);
    }
}


1			<?php
2			namespace Apie\FakeAnnotationsPlugin\Readers;
3
4			use Apie\Core\Annotations\ApiResource;
5			use Doctrine\Common\Annotations\Reader;
6			use ReflectionClass;
7			use ReflectionMethod;
8			use ReflectionProperty;
9
10			/**
11			* Extend the annotation reader with a config array to override the actual annotations if required. Should only
12			* work on the ApiResource annotation.
13			*/
14			class ExtendReaderWithConfigReader implements Reader
15			{
16			private $reader;
17
18			private $config;
19
20			/**
21			* @param Reader $reader
22			* @param ApiResource[] $config
23			*/
24			public function __construct(Reader $reader, array $config)
25			{
26			$this->reader = $reader;
27			$this->config = $config;
28			}
29
30			/**
31			* {@inheritDoc}
32			*/
33			public function getClassAnnotations(ReflectionClass $class)
34			{
35			$className = $class->getName();
36			$annotations = $this->reader->getClassAnnotations($class);
37			if (isset($this->config[$className])) {
38			$annotations = array_filter($annotations, function ($annotation) {
39			return !($annotation instanceof ApiResource);
40			});
41			$annotations[] = $this->config[$className];
42			}
43
44			return $annotations;
45			}
46
47			/**
48			* {@inheritDoc}
49			*/
50			public function getClassAnnotation(ReflectionClass $class, $annotationName)
51			{
52			$className = $class->getName();
53			if ($annotationName === ApiResource::class && isset($this->config[$className])) {
54			return $this->config[$className];
			0 ignored issues – show Bug Best Practice introduced 2021-02-14 21:10 UTC by Report Bug Copy Issue Report The expression `return $this->config[$className]` returns the type `Apie\Core\Annotations\ApiResource` which is incompatible with the return type mandated by `Doctrine\Common\Annotati...r::getClassAnnotation()` of `Doctrine\Common\Annotations\T\|null`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /** @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
55			}
56			return $this->reader->getClassAnnotation($class, $annotationName);
57			}
58
59			/**
60			* {@inheritDoc}
61			*/
62			public function getMethodAnnotations(ReflectionMethod $method)
63			{
64			return $this->reader->getMethodAnnotations($method);
65			}
66
67			/**
68			* {@inheritDoc}
69			*/
70			public function getMethodAnnotation(ReflectionMethod $method, $annotationName)
71			{
72			return $this->reader->getMethodAnnotation($method, $annotationName);
73			}
74
75			/**
76			* {@inheritDoc}
77			*/
78			public function getPropertyAnnotations(ReflectionProperty $property)
79			{
80			return $this->reader->getPropertyAnnotations($property);
81			}
82
83			/**
84			* {@inheritDoc}
85			*/
86			public function getPropertyAnnotation(ReflectionProperty $property, $annotationName)
87			{
88			return $this->reader->getPropertyAnnotation($property, $annotationName);
89			}
90			}
91

apie-lib / fake-annotations-plugin

ExtendReaderWithConfigReader A last analyzed 2021-02-14 21:10 UTC

Complexity

Size/Duplication

Importance

7 Methods

Duplication Side-by-Side

Filter issues like

ExtendReaderWithConfigReader A
last analyzed 2021-02-14 21:10 UTC