AnnotationDefinitionProvider::getDefinition() - Code Metrics - mikemirten/JsonApi - Measure and Improve Code Quality continuously with Scrutinizer

AnnotationDefinitionProvider::getDefinition() A
last analyzed 2019-01-15 22:11 UTC

↳ Parent: AnnotationDefinitionProvider

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	2

Importance

Changes

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

<?php
declare(strict_types = 1);

namespace Mikemirten\Component\JsonApi\Mapper\Definition;
use Mikemirten\Component\JsonApi\Mapper\Definition\AnnotationProcessor\AnnotationProcessorInterface;

/**
 * Annotation Definition Provider based on the Doctrine-Annotation library
 *
 * @package Mikemirten\Component\JsonApi\Mapper\Definition
 */
class AnnotationDefinitionProvider implements DefinitionProviderInterface
{
    /**
     * Registered annotation processors
     *
     * @var AnnotationProcessorInterface[]
     */
    private $processors = [];

    /**
     * Cache of created definitions
     *
     * @var array
     */
    private $definitionCache = [];

    /**
     * Register annotation processor
     *
     * @param AnnotationProcessorInterface $processor
     */
    public function registerProcessor(AnnotationProcessorInterface $processor)
    {
        $this->processors[] = $processor;
    }

    /**
     * {@inheritdoc}
     */
    public function getDefinition(string $class): Definition
    {
        if (! isset($this->definitionCache[$class])) {
            $reflection = new \ReflectionClass($class);

            $this->definitionCache[$class] = $this->createDefinition($reflection);
        }

        return $this->definitionCache[$class];
    }

    /**
     * Create definition for given class
     *
     * @param  \ReflectionClass $reflection
     * @return Definition
     */
    protected function createDefinition(\ReflectionClass $reflection): Definition
    {
        $definition = new Definition($reflection->getName());


        foreach ($this->processors as $processor)
        {
            $processor->process($reflection, $definition);
        }

        $parent = $reflection->getParentClass();

        if ($parent !== false) {
            $definition->merge($this->createDefinition($parent));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        foreach ($reflection->getTraits() as $trait)
        {
            $definition->merge($this->createDefinition($trait));
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

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

        return $definition;
    }
}

1		<?php
2		declare(strict_types = 1);
3
4		namespace Mikemirten\Component\JsonApi\Mapper\Definition;
5		use Mikemirten\Component\JsonApi\Mapper\Definition\AnnotationProcessor\AnnotationProcessorInterface;
6
7		/**
8		* Annotation Definition Provider based on the Doctrine-Annotation library
9		*
10		* @package Mikemirten\Component\JsonApi\Mapper\Definition
11		*/
12		class AnnotationDefinitionProvider implements DefinitionProviderInterface
13		{
14		/**
15		* Registered annotation processors
16		*
17		* @var AnnotationProcessorInterface[]
18		*/
19		private $processors = [];
20
21		/**
22		* Cache of created definitions
23		*
24		* @var array
25		*/
26		private $definitionCache = [];
27
28		/**
29		* Register annotation processor
30		*
31		* @param AnnotationProcessorInterface $processor
32		*/
33	1	public function registerProcessor(AnnotationProcessorInterface $processor)
34		{
35	1	$this->processors[] = $processor;
36	1	}
37
38		/**
39		* {@inheritdoc}
40		*/
41	4	public function getDefinition(string $class): Definition
42		{
43	4	if (! isset($this->definitionCache[$class])) {
44	4	$reflection = new \ReflectionClass($class);
45
46	4	$this->definitionCache[$class] = $this->createDefinition($reflection);
47		}
48
49	4	return $this->definitionCache[$class];
50		}
51
52		/**
53		* Create definition for given class
54		*
55		* @param \ReflectionClass $reflection
56		* @return Definition
57		*/
58	4	protected function createDefinition(\ReflectionClass $reflection): Definition
59		{
60	4	$definition = new Definition($reflection->getName());
		0 ignored issues – show Bug introduced 2017-04-26 21:01 UTC by Report Bug Copy Issue Report Consider using `$reflection->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
61
62	4	foreach ($this->processors as $processor)
63		{
64	1	$processor->process($reflection, $definition);
65		}
66
67	4	$parent = $reflection->getParentClass();
68
69	4	if ($parent !== false) {
70	1	$definition->merge($this->createDefinition($parent));
		0 ignored issues – show Documentation introduced 2017-04-26 21:01 UTC by Report Bug Copy Issue Report `$this->createDefinition($parent)` is of type `object<Mikemirten\Compon...\Definition\Definition>`, but the function expects a `object<self>`. 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...
71		}
72
73	4	foreach ($reflection->getTraits() as $trait)
74		{
75	1	$definition->merge($this->createDefinition($trait));
		0 ignored issues – show Documentation introduced 2017-05-04 20:59 UTC by Report Bug Copy Issue Report `$this->createDefinition($trait)` is of type `object<Mikemirten\Compon...\Definition\Definition>`, but the function expects a `object<self>`. 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...
76		}
77
78	4	return $definition;
79		}
80		}

mikemirten / JsonApi

AnnotationDefinitionProvider::getDefinition() A last analyzed 2019-01-15 22:11 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

AnnotationDefinitionProvider::getDefinition() A
last analyzed 2019-01-15 22:11 UTC