ClassMetadata::getNamePrefix() - Code Metrics - Inspection of "Adding link generation" - dontdrinkandroot/rest-bundle.php - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — standalone ( a45559...3ee90b )

by Philip

created 2017-03-01 15:40 UTC

ClassMetadata::getNamePrefix() A

↳ Parent: ClassMetadata

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

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

<?php

namespace Dontdrinkandroot\RestBundle\Metadata;

use Doctrine\Common\Inflector\Inflector;
use Dontdrinkandroot\RestBundle\Metadata\Annotation\Method;
use Metadata\MergeableClassMetadata;
use Metadata\MergeableInterface;

class ClassMetadata extends MergeableClassMetadata
{
    /**
     * @var bool
     */
    public $restResource;

    /**
     * @var string
     */
    public $namePrefix;

    /**
     * @var string
     */
    public $pathPrefix;

    /**
     * @var string
     */
    public $idField;

    /**
     * @var string
     */
    public $service;

    /**
     * @var string
     */
    public $controller;

    /**
     * @var Method[]|null
     */
    public $methods;

    public function __construct($name)
    {
        parent::__construct($name);

        $this->namePrefix = Inflector::tableize($this->reflection->getShortName());
        $this->pathPrefix = Inflector::pluralize(strtolower($this->reflection->getShortName()));
    }

    /**
     * {@inheritdoc}
     */
    public function merge(MergeableInterface $object)
    {
        if (!$object instanceof MergeableClassMetadata) {
            throw new \InvalidArgumentException('$object must be an instance of MergeableClassMetadata.');
        }

        $this->name = $object->name;
        $this->reflection = $object->reflection;
        $this->methodMetadata = array_merge($this->methodMetadata, $object->methodMetadata);
        $this->propertyMetadata = $this->mergePropertyMetadata($object);
        $this->fileResources = array_merge($this->fileResources, $object->fileResources);

        if ($object->createdAt < $this->createdAt) {
            $this->createdAt = $object->createdAt;
        }

        /** @var ClassMetadata $object */
        $this->restResource = $this->mergeField($this->restResource, $object->restResource);
        $this->idField = $this->mergeField($this->idField, $object->idField);
        $this->methods = $this->mergeField($this->methods, $object->methods);
        $this->namePrefix = $this->mergeField($this->namePrefix, $object->namePrefix);
        $this->pathPrefix = $this->mergeField($this->pathPrefix, $object->pathPrefix);
        $this->service = $this->mergeField($this->service, $object->service);
        $this->controller = $this->mergeField($this->controller, $object->controller);
    }

    /**
     * @param bool $restResource
     */
    public function setRestResource($restResource)
    {
        $this->restResource = $restResource;
    }

    /**
     * @return boolean
     */
    public function isRestResource()
    {
        return $this->restResource;
    }

    /**
     * @return string
     */
    public function getNamePrefix()
    {
        return $this->namePrefix;
    }

    /**
     * @param string $namePrefix
     */
    public function setNamePrefix($namePrefix)
    {
        $this->namePrefix = $namePrefix;
    }

    /**
     * @return string
     */
    public function getPathPrefix()
    {
        return $this->pathPrefix;
    }

    /**
     * @param string $pathPrefix
     */
    public function setPathPrefix(string $pathPrefix)
    {
        $this->pathPrefix = $pathPrefix;
    }

    /**
     * @return string
     */
    public function getController()
    {
        return $this->controller;
    }

    /**
     * @param string $controller
     */
    public function setController($controller)
    {
        $this->controller = $controller;
    }

    /**
     * @return string
     */
    public function getService()
    {
        return $this->service;
    }

    /**
     * @param string $service
     */
    public function setService($service)
    {
        $this->service = $service;
    }

    /**
     * @return Method[]
     */
    public function getMethods()
    {
        return $this->methods;
    }

    /**
     * @param string[] $methods
     */
    public function setMethods(array $methods)
    {
        $this->methods = $methods;

    }

    public function getPropertyMetadata(string $property): ?PropertyMetadata
    {
        if (array_key_exists($property, $this->propertyMetadata)) {
            return $this->propertyMetadata[$property];
        }

        return null;
    }

    /**
     * @param MergeableInterface $object
     *
     * @return array
     */
    protected function mergePropertyMetadata(MergeableInterface $object): array
    {
        /** @var ClassMetadata $object */
        /** @var PropertyMetadata[] $mergedMetadata */
        $mergedMetadata = $this->propertyMetadata;

        foreach ($object->propertyMetadata as $otherMetadata) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            /** @var PropertyMetadata $otherMetadata */
            if (array_key_exists($otherMetadata->name, $mergedMetadata)) {
                $mergedMetadata[$otherMetadata->name] = $mergedMetadata[$otherMetadata->name]->merge($otherMetadata);
            } else {
                $mergedMetadata[$otherMetadata->name] = $otherMetadata;
            }
        }

        return $mergedMetadata;
    }

    public function getMethod(string $methodName): ?Method
    {
        if (null === $this->methods) {
            return null;
        }

        foreach ($this->methods as $method) {
            if ($methodName === $method->name) {
                return $method;
            }
        }

        return null;
    }

    public function hasMethod($methodName)
    {
        return null !== $this->getMethod($methodName);
    }

    private function mergeField($existing, $toMerge)
    {
        if (null !== $toMerge) {
            return $toMerge;
        }

        return $existing;
    }

    public function getIdField(string $default = 'id'): string
    {
        if (null !== $this->idField) {
            return $this->idField;
        }

        return $default;
    }
}


1		<?php
2
3		namespace Dontdrinkandroot\RestBundle\Metadata;
4
5		use Doctrine\Common\Inflector\Inflector;
6		use Dontdrinkandroot\RestBundle\Metadata\Annotation\Method;
7		use Metadata\MergeableClassMetadata;
8		use Metadata\MergeableInterface;
9
10		class ClassMetadata extends MergeableClassMetadata
11		{
12		/**
13		* @var bool
14		*/
15		public $restResource;
16
17		/**
18		* @var string
19		*/
20		public $namePrefix;
21
22		/**
23		* @var string
24		*/
25		public $pathPrefix;
26
27		/**
28		* @var string
29		*/
30		public $idField;
31
32		/**
33		* @var string
34		*/
35		public $service;
36
37		/**
38		* @var string
39		*/
40		public $controller;
41
42		/**
43		* @var Method[]\|null
44		*/
45		public $methods;
46
47	34	public function __construct($name)
48		{
49	34	parent::__construct($name);
50
51	34	$this->namePrefix = Inflector::tableize($this->reflection->getShortName());
52	34	$this->pathPrefix = Inflector::pluralize(strtolower($this->reflection->getShortName()));
53	34	}
54
55		/**
56		* {@inheritdoc}
57		*/
58	8	public function merge(MergeableInterface $object)
59		{
60	8	if (!$object instanceof MergeableClassMetadata) {
61		throw new \InvalidArgumentException('$object must be an instance of MergeableClassMetadata.');
62		}
63
64	8	$this->name = $object->name;
65	8	$this->reflection = $object->reflection;
66	8	$this->methodMetadata = array_merge($this->methodMetadata, $object->methodMetadata);
67	8	$this->propertyMetadata = $this->mergePropertyMetadata($object);
68	8	$this->fileResources = array_merge($this->fileResources, $object->fileResources);
69
70	8	if ($object->createdAt < $this->createdAt) {
71		$this->createdAt = $object->createdAt;
72		}
73
74		/** @var ClassMetadata $object */
75	8	$this->restResource = $this->mergeField($this->restResource, $object->restResource);
76	8	$this->idField = $this->mergeField($this->idField, $object->idField);
77	8	$this->methods = $this->mergeField($this->methods, $object->methods);
78	8	$this->namePrefix = $this->mergeField($this->namePrefix, $object->namePrefix);
79	8	$this->pathPrefix = $this->mergeField($this->pathPrefix, $object->pathPrefix);
80	8	$this->service = $this->mergeField($this->service, $object->service);
81	8	$this->controller = $this->mergeField($this->controller, $object->controller);
82	8	}
83
84		/**
85		* @param bool $restResource
86		*/
87	34	public function setRestResource($restResource)
88		{
89	34	$this->restResource = $restResource;
90	34	}
91
92		/**
93		* @return boolean
94		*/
95	26	public function isRestResource()
96		{
97	26	return $this->restResource;
98		}
99
100		/**
101		* @return string
102		*/
103	6	public function getNamePrefix()
104		{
105	6	return $this->namePrefix;
106		}
107
108		/**
109		* @param string $namePrefix
110		*/
111		public function setNamePrefix($namePrefix)
112		{
113		$this->namePrefix = $namePrefix;
114		}
115
116		/**
117		* @return string
118		*/
119	6	public function getPathPrefix()
120		{
121	6	return $this->pathPrefix;
122		}
123
124		/**
125		* @param string $pathPrefix
126		*/
127	24	public function setPathPrefix(string $pathPrefix)
128		{
129	24	$this->pathPrefix = $pathPrefix;
130	24	}
131
132		/**
133		* @return string
134		*/
135	6	public function getController()
136		{
137	6	return $this->controller;
138		}
139
140		/**
141		* @param string $controller
142		*/
143		public function setController($controller)
144		{
145		$this->controller = $controller;
146		}
147
148		/**
149		* @return string
150		*/
151	6	public function getService()
152		{
153	6	return $this->service;
154		}
155
156		/**
157		* @param string $service
158		*/
159		public function setService($service)
160		{
161		$this->service = $service;
162		}
163
164		/**
165		* @return Method[]
166		*/
167		public function getMethods()
168		{
169		return $this->methods;
170		}
171
172		/**
173		* @param string[] $methods
174		*/
175	34	public function setMethods(array $methods)
176		{
177	34	$this->methods = $methods;
		0 ignored issues – show Documentation Bug introduced 2017-03-01 14:43 UTC by Report Bug Copy Issue Report It seems like `$methods` of type `array<integer,string>` is incompatible with the declared type `array<integer,object<Don...nnotation\Method>>\|null` of property `$methods`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
178	34	}
179
180	34	public function getPropertyMetadata(string $property): ?PropertyMetadata
181		{
182	34	if (array_key_exists($property, $this->propertyMetadata)) {
183	34	return $this->propertyMetadata[$property];
184		}
185
186	30	return null;
187		}
188
189		/**
190		* @param MergeableInterface $object
191		*
192		* @return array
193		*/
194	8	protected function mergePropertyMetadata(MergeableInterface $object): array
195		{
196		/** @var ClassMetadata $object */
197		/** @var PropertyMetadata[] $mergedMetadata */
198	8	$mergedMetadata = $this->propertyMetadata;
199
200	8	foreach ($object->propertyMetadata as $otherMetadata) {
		0 ignored issues – show Bug introduced 2017-02-26 20:36 UTC by Report Bug Copy Issue Report Accessing `propertyMetadata` on the interface `Metadata\MergeableInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
201		/** @var PropertyMetadata $otherMetadata */
202	8	if (array_key_exists($otherMetadata->name, $mergedMetadata)) {
203	6	$mergedMetadata[$otherMetadata->name] = $mergedMetadata[$otherMetadata->name]->merge($otherMetadata);
204		} else {
205	8	$mergedMetadata[$otherMetadata->name] = $otherMetadata;
206		}
207		}
208
209	8	return $mergedMetadata;
210		}
211
212	32	public function getMethod(string $methodName): ?Method
213		{
214	32	if (null === $this->methods) {
215		return null;
216		}
217
218	32	foreach ($this->methods as $method) {
219	32	if ($methodName === $method->name) {
220	32	return $method;
221		}
222		}
223
224	6	return null;
225		}
226
227	24	public function hasMethod($methodName)
228		{
229	24	return null !== $this->getMethod($methodName);
230		}
231
232	8	private function mergeField($existing, $toMerge)
233		{
234	8	if (null !== $toMerge) {
235	8	return $toMerge;
236		}
237
238	8	return $existing;
239		}
240
241	2	public function getIdField(string $default = 'id'): string
242		{
243	2	if (null !== $this->idField) {
244		return $this->idField;
245		}
246
247	2	return $default;
248		}
249		}
250

dontdrinkandroot / rest-bundle.php

Push — standalone ( a45559...3ee90b )

ClassMetadata::getNamePrefix() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like