AnnotationDriver::__construct() - Code Metrics - Inspection of "update license year" - Ma27/Ma27ApiKeyAuthenticationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Branch — develop (0737e3)

by Maximilian

created 2016-11-18 22:28 UTC

AnnotationDriver::__construct() A

↳ Parent: AnnotationDriver

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	5
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	2

<?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();
        $loginProperty = $passwordProperty = $apiKeyProperty = $lastActionProperty = null;

        foreach ($properties as $reflectionProperty) {
            foreach (array('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) {
                    switch ($annotation) {
                        case 'login':
                            $this->assertUnique($loginProperty);
                            $loginProperty = $reflectionProperty;
                            break;
                        case 'password':
                            $this->assertUnique($passwordProperty);
                            $passwordProperty = $reflectionProperty;
                            break;
                        case 'apiKey':
                            $this->assertUnique($apiKeyProperty);
                            $apiKeyProperty = $reflectionProperty;
                            break;
                        case 'lastAction':
                            $this->assertUnique($lastActionProperty);
                            $lastActionProperty = $reflectionProperty;
                    }

                    if ($loginProperty && $passwordProperty && $apiKeyProperty && $lastActionProperty) {
                        break;
                    }

                    continue;
                }
            }
        }

        if (!$loginProperty || !$passwordProperty || !$apiKeyProperty) {
            throw new \LogicException(sprintf(
                'A user class must have a "%s", "%s", "%s" annotation!',
                'Login',
                'Password',
                'ApiKey'
            ));
        }

        return array(
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());
}
            ClassMetadata::LOGIN_PROPERTY       => $loginProperty,
            ClassMetadata::PASSWORD_PROPERTY    => $passwordProperty,
            ClassMetadata::API_KEY_PROPERTY     => $apiKeyProperty,
            ClassMetadata::LAST_ACTION_PROPERTY => $lastActionProperty,
        );
    }

    /**
     * Checks whether a property is already set.
     *
     * @param \ReflectionProperty $property
     */
    private function assertUnique(\ReflectionProperty $property = null)
    {
        if (!empty($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!');
    }
}


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			public function __construct(Reader $annotationReader, $userClass)
33			{
34			$this->reader = $annotationReader;
35			$this->userClass = (string) $userClass;
36			}
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			public function getMetadataForUser()
45			{
46			$reflection = new ReflectionClass($this->userClass);
47			$properties = $reflection->getProperties();
48			$loginProperty = $passwordProperty = $apiKeyProperty = $lastActionProperty = null;
49
50			foreach ($properties as $reflectionProperty) {
51			foreach (array('login', 'password', 'apiKey', 'lastAction') as $annotation) {
52			$class = sprintf('Ma27\\ApiKeyAuthenticationBundle\\Annotation\\%s', ucfirst($annotation));
53			$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...
54
55			if ($annotationObject) {
56			switch ($annotation) {
57			case 'login':
58			$this->assertUnique($loginProperty);
59			$loginProperty = $reflectionProperty;
60			break;
61			case 'password':
62			$this->assertUnique($passwordProperty);
63			$passwordProperty = $reflectionProperty;
64			break;
65			case 'apiKey':
66			$this->assertUnique($apiKeyProperty);
67			$apiKeyProperty = $reflectionProperty;
68			break;
69			case 'lastAction':
70			$this->assertUnique($lastActionProperty);
71			$lastActionProperty = $reflectionProperty;
72			}
73
74			if ($loginProperty && $passwordProperty && $apiKeyProperty && $lastActionProperty) {
75			break;
76			}
77
78			continue;
79			}
80			}
81			}
82
83			if (!$loginProperty \|\| !$passwordProperty \|\| !$apiKeyProperty) {
84			throw new \LogicException(sprintf(
85			'A user class must have a "%s", "%s", "%s" annotation!',
86			'Login',
87			'Password',
88			'ApiKey'
89			));
90			}
91
92			return array(
			0 ignored issues – show Best Practice introduced 2016-11-18 22:40 UTC by Report Bug Copy Issue Report The expression `return array(\Ma27\ApiKe...> $lastActionProperty);` 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...
93			ClassMetadata::LOGIN_PROPERTY => $loginProperty,
94			ClassMetadata::PASSWORD_PROPERTY => $passwordProperty,
95			ClassMetadata::API_KEY_PROPERTY => $apiKeyProperty,
96			ClassMetadata::LAST_ACTION_PROPERTY => $lastActionProperty,
97			);
98			}
99
100			/**
101			* Checks whether a property is already set.
102			*
103			* @param \ReflectionProperty $property
104			*/
105			private function assertUnique(\ReflectionProperty $property = null)
106			{
107			if (!empty($property)) {
108			throw $this->createDuplicateAnnotationException();
109			}
110			}
111
112			/**
113			* Creates the exception when.
114			*
115			* @return \InvalidArgumentException
116			*/
117			private function createDuplicateAnnotationException()
118			{
119			return new \InvalidArgumentException('None of the Ma27\\ApiKeyAuthenticationBundle annotations can be declared twice!');
120			}
121			}
122

Ma27 / Ma27ApiKeyAuthenticationBundle

GitHub Access Token became invalid

Branch — develop (0737e3)

AnnotationDriver::__construct() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like