AnnotationDriver::createDuplicateAnnotationException() - Code Metrics - Inspection of "Merge pull request #31 from Ma27/gh-30" - Ma27/Ma27ApiKeyAuthenticationBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6daa1e...29b462 )

by Maximilian

created 2016-01-19 18:44 UTC

createDuplicateAnnotationException() A

↳ Parent: AnnotationDriver

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	0

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

<?php

namespace Ma27\ApiKeyAuthenticationBundle\Annotation\Driver;

use Doctrine\Common\Annotations\Reader;
use Ma27\ApiKeyAuthenticationBundle\Model\User\ClassMetadata;
use Ma27\ApiKeyAuthenticationBundle\Model\User\ModelConfigurationDriverInterface;
use ReflectionClass;

/**
 * Annotation driver which parses the annotations of the user model instance.
 */
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':
                            if (!empty($loginProperty)) {
                                throw $this->createDuplicateAnnotationException();
                            }

                            $loginProperty = $reflectionProperty;
                            break;
                        case 'password':
                            if (!empty($passwordProperty)) {
                                throw $this->createDuplicateAnnotationException();
                            }

                            $passwordProperty = $reflectionProperty;
                            break;
                        case 'apiKey':
                            if (!empty($apiKeyProperty)) {
                                throw $this->createDuplicateAnnotationException();
                            }

                            $apiKeyProperty = $reflectionProperty;
                            break;
                        case 'lastAction':
                            if (!empty($lastActionProperty)) {
                                throw $this->createDuplicateAnnotationException();
                            }

                            $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 new ClassMetadata(
            $reflection,
            $this->userClass,
            array(
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                ClassMetadata::LOGIN_PROPERTY       => $loginProperty,
                ClassMetadata::PASSWORD_PROPERTY    => $passwordProperty,
                ClassMetadata::API_KEY_PROPERTY     => $apiKeyProperty,
                ClassMetadata::LAST_ACTION_PROPERTY => $lastActionProperty,
            )
        );
    }

    /**
     * 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\Annotation\Driver;
4
5		use Doctrine\Common\Annotations\Reader;
6		use Ma27\ApiKeyAuthenticationBundle\Model\User\ClassMetadata;
7		use Ma27\ApiKeyAuthenticationBundle\Model\User\ModelConfigurationDriverInterface;
8		use ReflectionClass;
9
10		/**
11		* Annotation driver which parses the annotations of the user model instance.
12		*/
13		final class AnnotationDriver implements ModelConfigurationDriverInterface
14		{
15		/**
16		* @var Reader
17		*/
18		private $reader;
19
20		/**
21		* @var string
22		*/
23		private $userClass;
24
25		/**
26		* Constructor.
27		*
28		* @param Reader $annotationReader
29		* @param string $userClass
30		*/
31	7	public function __construct(Reader $annotationReader, $userClass)
32		{
33	7	$this->reader = $annotationReader;
34	7	$this->userClass = (string) $userClass;
35	7	}
36
37		/**
38		* {@inheritdoc}
39		*
40		* @throws \LogicException If one of the annotations is missing
41		* @throws \LogicException If one property has multiple "auth" annotations
42		*/
43	7	public function getMetadataForUser()
44		{
45	7	$reflection = new ReflectionClass($this->userClass);
46	7	$properties = $reflection->getProperties();
47	7	$loginProperty = $passwordProperty = $apiKeyProperty = $lastActionProperty = null;
48
49	7	foreach ($properties as $reflectionProperty) {
50	7	foreach (array('login', 'password', 'apiKey', 'lastAction') as $annotation) {
51	7	$class = sprintf('Ma27\\ApiKeyAuthenticationBundle\\Annotation\\%s', ucfirst($annotation));
52	7	$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...
53
54	7	if ($annotationObject) {
55		switch ($annotation) {
56	7	case 'login':
57	6	if (!empty($loginProperty)) {
58		throw $this->createDuplicateAnnotationException();
59		}
60
61	6	$loginProperty = $reflectionProperty;
62	6	break;
63	7	case 'password':
64	6	if (!empty($passwordProperty)) {
65		throw $this->createDuplicateAnnotationException();
66		}
67
68	6	$passwordProperty = $reflectionProperty;
69	6	break;
70	7	case 'apiKey':
71	7	if (!empty($apiKeyProperty)) {
72		throw $this->createDuplicateAnnotationException();
73		}
74
75	7	$apiKeyProperty = $reflectionProperty;
76	7	break;
77		case 'lastAction':
78		if (!empty($lastActionProperty)) {
79		throw $this->createDuplicateAnnotationException();
80		}
81
82		$lastActionProperty = $reflectionProperty;
83		}
84
85		if ($loginProperty
86	7	&& $passwordProperty
87	7	&& $apiKeyProperty
88	7	&& $lastActionProperty
89	7	) {
90		break;
91		}
92
93	7	continue;
94		}
95	7	}
96	7	}
97
98	7	if (!$loginProperty \|\| !$passwordProperty \|\| !$apiKeyProperty) {
99	1	throw new \LogicException(sprintf(
100	1	'A user class must have a "%s", "%s", "%s" annotation!',
101	1	'Login',
102	1	'Password',
103		'ApiKey'
104	1	));
105		}
106
107	6	return new ClassMetadata(
108	6	$reflection,
109	6	$this->userClass,
110		array(
		0 ignored issues – show Documentation introduced 2015-12-30 17:36 UTC by Report Bug Copy Issue Report `array(\Ma27\ApiKeyAuthen...=> $lastActionProperty)` is of type `array<string\|integer,obj...flectionProperty>\|null>`, but the function expects a `array<integer,object<ReflectionProperty>>`. 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...
111	6	ClassMetadata::LOGIN_PROPERTY => $loginProperty,
112	6	ClassMetadata::PASSWORD_PROPERTY => $passwordProperty,
113	6	ClassMetadata::API_KEY_PROPERTY => $apiKeyProperty,
114	6	ClassMetadata::LAST_ACTION_PROPERTY => $lastActionProperty,
115		)
116	6	);
117		}
118
119		/**
120		* Creates the exception when.
121		*
122		* @return \InvalidArgumentException
123		*/
124		private function createDuplicateAnnotationException()
125		{
126		return new \InvalidArgumentException('None of the Ma27\\ApiKeyAuthenticationBundle annotations can be declared twice!');
127		}
128		}
129

Ma27 / Ma27ApiKeyAuthenticationBundle

GitHub Access Token became invalid

Push — master ( 6daa1e...29b462 )

createDuplicateAnnotationException() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like