AnnotationDriver - Code Metrics - Ma27/Ma27ApiKeyAuthenticationBundle - Measure and Improve Code Quality continuously with Scrutinizer

AnnotationDriver A
last analyzed 2018-04-11 21:35 UTC

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	121
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

93.48%

Importance

Changes

Metric	Value
wmc	20
lcom	1
cbo	1
dl	0
loc	121
ccs	43
cts	46
cp	0.9348
rs	10
c	0
b	0
f	0

5 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
C	getMetadataForUser()	51	12
A	assertUnique()	6	2
A	createDuplicateAnnotationException()	4	1
A	isMetadataFullyLoaded()	7	4

<?php

namespace Ma27\ApiKeyAuthenticationBundle\Service\Mapping\Driver;

use Doctrine\Common\Annotations\Reader;
use Ma27\ApiKeyAuthenticationBundle\Service\Mapping\ClassMetadata;
use ReflectionClass;

/**
 * Annotation driver which parses the annotations of the user model instance.
 *
 * @internal This code is part of the internal API to gather the appropriate model information and shouldn't be used for else use-cases
 */
final class AnnotationDriver implements ModelConfigurationDriverInterface
{
    /**
     * @var Reader
     */
    private $reader;

    /**
     * @var string
     */
    private $userClass;

    /**
     * Constructor.
     *
     * @param Reader $annotationReader
     * @param string $userClass
     */
    public function __construct(Reader $annotationReader, $userClass)
    {
        $this->reader = $annotationReader;
        $this->userClass = (string) $userClass;
    }

    /**
     * {@inheritdoc}
     *
     * @throws \LogicException If one of the annotations is missing
     * @throws \LogicException If one property has multiple "auth" annotations
     */
    public function getMetadataForUser()
    {
        $reflection = new ReflectionClass($this->userClass);
        $properties = $reflection->getProperties();
        $metadata = [
            ClassMetadata::LOGIN_PROPERTY       => null,
            ClassMetadata::PASSWORD_PROPERTY    => null,
            ClassMetadata::API_KEY_PROPERTY     => null,
            ClassMetadata::LAST_ACTION_PROPERTY => null,
        ];

        foreach ($properties as $reflectionProperty) {
            foreach (['login', 'password', 'apiKey', 'lastAction'] as $annotation) {
                $class = sprintf('Ma27\\ApiKeyAuthenticationBundle\\Annotation\\%s', ucfirst($annotation));
                $annotationObject = $this->reader->getPropertyAnnotation($reflectionProperty, $class);
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();

                if (!$annotationObject) {
                    continue;
                }

                switch ($annotation) {
                    case 'login':
                        $this->assertUnique($metadata[ClassMetadata::LOGIN_PROPERTY]);
                        $metadata[ClassMetadata::LOGIN_PROPERTY] = $reflectionProperty;
                        break;
                    case 'password':
                        $this->assertUnique($metadata[ClassMetadata::PASSWORD_PROPERTY]);
                        $metadata[ClassMetadata::PASSWORD_PROPERTY] = $reflectionProperty;
                        break;
                    case 'apiKey':
                        $this->assertUnique($metadata[ClassMetadata::API_KEY_PROPERTY]);
                        $metadata[ClassMetadata::API_KEY_PROPERTY] = $reflectionProperty;
                        break;
                    case 'lastAction':
                        $this->assertUnique($metadata[ClassMetadata::LAST_ACTION_PROPERTY]);
                        $metadata[ClassMetadata::LAST_ACTION_PROPERTY] = $reflectionProperty;
                        break;
                }

                if ($this->isMetadataFullyLoaded($metadata)) {
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        if (!$metadata[ClassMetadata::LOGIN_PROPERTY] || !$metadata[ClassMetadata::PASSWORD_PROPERTY] || !$metadata[ClassMetadata::API_KEY_PROPERTY]) {
            throw new \LogicException('A user class must have a "Login", "Password", "ApiKey" annotation!');
        }

        return $metadata;
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * Checks whether a property is already set.
     *
     * @param \ReflectionProperty $property
     *
     * @throws \InvalidArgumentException
     */
    private function assertUnique(\ReflectionProperty $property = null)
    {
        if (null !== $property) {
            throw $this->createDuplicateAnnotationException();
        }
    }

    /**
     * Creates the exception when.
     *
     * @return \InvalidArgumentException
     */
    private function createDuplicateAnnotationException()
    {
        return new \InvalidArgumentException('None of the Ma27\\ApiKeyAuthenticationBundle annotations can be declared twice!');
    }

    /**
     * Method which checks if all metadata annotations were loaded already.
     *
     * @param object[] $metadata
     *
     * @return bool
     */
    private function isMetadataFullyLoaded(array $metadata)
    {
        return $metadata[ClassMetadata::LOGIN_PROPERTY]
            && $metadata[ClassMetadata::PASSWORD_PROPERTY]
            && $metadata[ClassMetadata::API_KEY_PROPERTY]
            && $metadata[ClassMetadata::LAST_ACTION_PROPERTY];
    }
}


1		<?php
2
3		namespace Ma27\ApiKeyAuthenticationBundle\Service\Mapping\Driver;
4
5		use Doctrine\Common\Annotations\Reader;
6		use Ma27\ApiKeyAuthenticationBundle\Service\Mapping\ClassMetadata;
7		use ReflectionClass;
8
9		/**
10		* Annotation driver which parses the annotations of the user model instance.
11		*
12		* @internal This code is part of the internal API to gather the appropriate model information and shouldn't be used for else use-cases
13		*/
14		final class AnnotationDriver implements ModelConfigurationDriverInterface
15		{
16		/**
17		* @var Reader
18		*/
19		private $reader;
20
21		/**
22		* @var string
23		*/
24		private $userClass;
25
26		/**
27		* Constructor.
28		*
29		* @param Reader $annotationReader
30		* @param string $userClass
31		*/
32	16	public function __construct(Reader $annotationReader, $userClass)
33		{
34	16	$this->reader = $annotationReader;
35	16	$this->userClass = (string) $userClass;
36	16	}
37
38		/**
39		* {@inheritdoc}
40		*
41		* @throws \LogicException If one of the annotations is missing
42		* @throws \LogicException If one property has multiple "auth" annotations
43		*/
44	10	public function getMetadataForUser()
45		{
46	10	$reflection = new ReflectionClass($this->userClass);
47	10	$properties = $reflection->getProperties();
48		$metadata = [
49	10	ClassMetadata::LOGIN_PROPERTY => null,
50		ClassMetadata::PASSWORD_PROPERTY => null,
51		ClassMetadata::API_KEY_PROPERTY => null,
52		ClassMetadata::LAST_ACTION_PROPERTY => null,
53		];
54
55	10	foreach ($properties as $reflectionProperty) {
56	10	foreach (['login', 'password', 'apiKey', 'lastAction'] as $annotation) {
57	10	$class = sprintf('Ma27\\ApiKeyAuthenticationBundle\\Annotation\\%s', ucfirst($annotation));
58	10	$annotationObject = $this->reader->getPropertyAnnotation($reflectionProperty, $class);
		0 ignored issues – show Bug introduced 2015-12-30 17:36 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$annotationObject` is correct as `$this->reader->getProper...ectionProperty, $class)` (which targets `Doctrine\Common\Annotati...getPropertyAnnotation()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
59
60	10	if (!$annotationObject) {
61	10	continue;
62		}
63
64		switch ($annotation) {
65	10	case 'login':
66	9	$this->assertUnique($metadata[ClassMetadata::LOGIN_PROPERTY]);
67	9	$metadata[ClassMetadata::LOGIN_PROPERTY] = $reflectionProperty;
68	9	break;
69	10	case 'password':
70	9	$this->assertUnique($metadata[ClassMetadata::PASSWORD_PROPERTY]);
71	9	$metadata[ClassMetadata::PASSWORD_PROPERTY] = $reflectionProperty;
72	9	break;
73	10	case 'apiKey':
74	10	$this->assertUnique($metadata[ClassMetadata::API_KEY_PROPERTY]);
75	10	$metadata[ClassMetadata::API_KEY_PROPERTY] = $reflectionProperty;
76	10	break;
77	9	case 'lastAction':
78	9	$this->assertUnique($metadata[ClassMetadata::LAST_ACTION_PROPERTY]);
79	9	$metadata[ClassMetadata::LAST_ACTION_PROPERTY] = $reflectionProperty;
80	9	break;
81		}
82
83	10	if ($this->isMetadataFullyLoaded($metadata)) {
		0 ignored issues – show Documentation introduced 2017-01-12 15:51 UTC by Report Bug Copy Issue Report `$metadata` is of type `array<string\|integer,nul...ct<ReflectionProperty>>`, but the function expects a `array<integer,object>`. 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...
84	10	break 2;
85		}
86		}
87		}
88
89	10	if (!$metadata[ClassMetadata::LOGIN_PROPERTY] \|\| !$metadata[ClassMetadata::PASSWORD_PROPERTY] \|\| !$metadata[ClassMetadata::API_KEY_PROPERTY]) {
90	1	throw new \LogicException('A user class must have a "Login", "Password", "ApiKey" annotation!');
91		}
92
93	9	return $metadata;
		0 ignored issues – show Best Practice introduced 2017-01-12 15:51 UTC by Report Bug Copy Issue Report The expression `return $metadata;` seems to be an `array`, but some of its elements' types (`null`) are incompatible with the return type declared by the interface `Ma27\ApiKeyAuthenticatio...ace::getMetadataForUser` of type `ReflectionProperty[]`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return 'Johannes'; } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
94		}
95
96		/**
97		* Checks whether a property is already set.
98		*
99		* @param \ReflectionProperty $property
100		*
101		* @throws \InvalidArgumentException
102		*/
103	10	private function assertUnique(\ReflectionProperty $property = null)
104		{
105	10	if (null !== $property) {
106		throw $this->createDuplicateAnnotationException();
107		}
108	10	}
109
110		/**
111		* Creates the exception when.
112		*
113		* @return \InvalidArgumentException
114		*/
115		private function createDuplicateAnnotationException()
116		{
117		return new \InvalidArgumentException('None of the Ma27\\ApiKeyAuthenticationBundle annotations can be declared twice!');
118		}
119
120		/**
121		* Method which checks if all metadata annotations were loaded already.
122		*
123		* @param object[] $metadata
124		*
125		* @return bool
126		*/
127	10	private function isMetadataFullyLoaded(array $metadata)
128		{
129	10	return $metadata[ClassMetadata::LOGIN_PROPERTY]
130	10	&& $metadata[ClassMetadata::PASSWORD_PROPERTY]
131	10	&& $metadata[ClassMetadata::API_KEY_PROPERTY]
132	10	&& $metadata[ClassMetadata::LAST_ACTION_PROPERTY];
133		}
134		}
135

Ma27 / Ma27ApiKeyAuthenticationBundle

GitHub Access Token became invalid

AnnotationDriver A last analyzed 2018-04-11 21:35 UTC

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

5 Methods

Duplication Side-by-Side

Filter issues like

AnnotationDriver A
last analyzed 2018-04-11 21:35 UTC