ReflectionParameterMagic::getDefaultValueDefinition() - Code Metrics - Inspection of "[issue #746] fixed missing default value in magic..." - apigen/ApiGen - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#755)

by Виктор

created 2016-09-29 11:51 UTC

getDefaultValueDefinition() A

↳ Parent: ReflectionParameterMagic

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * This file is part of the ApiGen (http://apigen.org)
 *
 * For the full copyright and license information, please view
 * the file LICENSE that was distributed with this source code.
 */

namespace ApiGen\Parser\Reflection;

use ApiGen\Contracts\Parser\Reflection\ClassReflectionInterface;
use ApiGen\Contracts\Parser\Reflection\Magic\MagicParameterReflectionInterface;
use TokenReflection;

class ReflectionParameterMagic extends ReflectionParameter implements MagicParameterReflectionInterface
{

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

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

    /**
     * @var int
     */
    private $position;

    /**
     * @var bool
     */
    private $defaultValueDefinition;

    /**
     * @var bool
     */
    private $unlimited;

    /**
     * @var bool
     */
    private $passedByReference;

    /**
     * @var ReflectionMethodMagic
     */
    private $declaringFunction;


    public function __construct(array $settings)
    {
        $this->name = $settings['name'];
        $this->position = $settings['position'];
        $this->typeHint = $settings['typeHint'];
        $this->defaultValueDefinition = $settings['defaultValueDefinition'];
        $this->unlimited = $settings['unlimited'];
        $this->passedByReference = $settings['passedByReference'];
        $this->declaringFunction = $settings['declaringFunction'];

        $this->reflectionType = get_class($this);
    }


    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return $this->name;
    }


    /**
     * {@inheritdoc}
     */
    public function getTypeHint()
    {
        return $this->typeHint;
    }


    /**
     * {@inheritdoc}
     */
    public function getFileName()
    {
        return $this->declaringFunction->getFileName();
    }


    /**
     * {@inheritdoc}
     */
    public function isTokenized()
    {
        return true;
    }


    /**
     * {@inheritdoc}
     */
    public function getPrettyName()
    {
        return str_replace('()', '($' . $this->name . ')', $this->declaringFunction->getPrettyName());
    }


    /**
     * {@inheritdoc}
     */
    public function getDeclaringClass()
    {
        return $this->declaringFunction->getDeclaringClass();
    }


    /**
     * {@inheritdoc}
     */
    public function getDeclaringClassName()
    {
        return $this->declaringFunction->getDeclaringClassName();
    }


    /**
     * {@inheritdoc}
     */
    public function getDeclaringFunction()
    {
        return $this->declaringFunction;
    }


    /**
     * {@inheritdoc}
     */
    public function getDeclaringFunctionName()
    {
        return $this->declaringFunction->getName();
    }


    /**
     * {@inheritdoc}
     */
    public function getStartLine()
    {
        return $this->declaringFunction->getStartLine();
    }


    /**
     * {@inheritdoc}
     */
    public function getEndLine()
    {
        return $this->declaringFunction->getEndLine();
    }


    /**
     * {@inheritdoc}
     */
    public function getDocComment()
    {
        return '';
    }


    /**
     * {@inheritdoc}
     */
    public function isDefaultValueAvailable()
    {
        return (bool) $this->defaultValueDefinition;
    }

    /**
     * {@inheritdoc}
     */
    public function getDefaultValueDefinition()
    {
        return $this->defaultValueDefinition;
class Author {
    private $name;

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

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

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

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

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

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


    /**
     * {@inheritdoc}
     */
    public function getPosition()
    {
        return $this->position;
    }


    /**
     * {@inheritdoc}
     */
    public function isArray()
    {
        return TokenReflection\ReflectionParameter::ARRAY_TYPE_HINT === $this->typeHint;
    }


    /**
     * {@inheritdoc}
     */
    public function isCallable()
    {
        return TokenReflection\ReflectionParameter::CALLABLE_TYPE_HINT === $this->typeHint;
    }


    /**
     * {@inheritdoc}
     */
    public function getClass()
    {
        $className = $this->getClassName();
        return $className === null ? null : $this->getParsedClasses()[$className];
    }


    /**
     * {@inheritdoc}
     */
    public function getClassName()
    {
        if ($this->isArray() || $this->isCallable()) {
            return null;
        }
        if (isset($this->getParsedClasses()[$this->typeHint])) {
            return $this->typeHint;
        }

        return null;
    }


    /**
     * {@inheritdoc}
     */
    public function allowsNull()
    {
        if ($this->isArray() || $this->isCallable()) {
            return strtolower($this->defaultValueDefinition) === 'null';
        }

        return ! empty($this->defaultValueDefinition);
    }


    /**
     * {@inheritdoc}
     */
    public function isOptional()
    {
        return $this->isDefaultValueAvailable();
    }


    /**
     * {@inheritdoc}
     */
    public function isPassedByReference()
    {
        return $this->passedByReference;
    }


    /**
     * {@inheritdoc}
     */
    public function canBePassedByValue()
    {
        return false;
    }


    /**
     * {@inheritdoc}
     */
    public function isUnlimited()
    {
        return $this->unlimited;
    }
}


1			<?php
2
3			/**
4			* This file is part of the ApiGen (http://apigen.org)
5			*
6			* For the full copyright and license information, please view
7			* the file LICENSE that was distributed with this source code.
8			*/
9
10			namespace ApiGen\Parser\Reflection;
11
12			use ApiGen\Contracts\Parser\Reflection\ClassReflectionInterface;
13			use ApiGen\Contracts\Parser\Reflection\Magic\MagicParameterReflectionInterface;
14			use TokenReflection;
15
16			class ReflectionParameterMagic extends ReflectionParameter implements MagicParameterReflectionInterface
17			{
18
19			/**
20			* @var string
21			*/
22			private $name;
23
24			/**
25			* @var string
26			*/
27			private $typeHint;
28
29			/**
30			* @var int
31			*/
32			private $position;
33
34			/**
35			* @var bool
36			*/
37			private $defaultValueDefinition;
38
39			/**
40			* @var bool
41			*/
42			private $unlimited;
43
44			/**
45			* @var bool
46			*/
47			private $passedByReference;
48
49			/**
50			* @var ReflectionMethodMagic
51			*/
52			private $declaringFunction;
53
54
55			public function __construct(array $settings)
56			{
57			$this->name = $settings['name'];
58			$this->position = $settings['position'];
59			$this->typeHint = $settings['typeHint'];
60			$this->defaultValueDefinition = $settings['defaultValueDefinition'];
61			$this->unlimited = $settings['unlimited'];
62			$this->passedByReference = $settings['passedByReference'];
63			$this->declaringFunction = $settings['declaringFunction'];
64
65			$this->reflectionType = get_class($this);
66			}
67
68
69			/**
70			* {@inheritdoc}
71			*/
72			public function getName()
73			{
74			return $this->name;
75			}
76
77
78			/**
79			* {@inheritdoc}
80			*/
81			public function getTypeHint()
82			{
83			return $this->typeHint;
84			}
85
86
87			/**
88			* {@inheritdoc}
89			*/
90			public function getFileName()
91			{
92			return $this->declaringFunction->getFileName();
93			}
94
95
96			/**
97			* {@inheritdoc}
98			*/
99			public function isTokenized()
100			{
101			return true;
102			}
103
104
105			/**
106			* {@inheritdoc}
107			*/
108			public function getPrettyName()
109			{
110			return str_replace('()', '($' . $this->name . ')', $this->declaringFunction->getPrettyName());
111			}
112
113
114			/**
115			* {@inheritdoc}
116			*/
117			public function getDeclaringClass()
118			{
119			return $this->declaringFunction->getDeclaringClass();
120			}
121
122
123			/**
124			* {@inheritdoc}
125			*/
126			public function getDeclaringClassName()
127			{
128			return $this->declaringFunction->getDeclaringClassName();
129			}
130
131
132			/**
133			* {@inheritdoc}
134			*/
135			public function getDeclaringFunction()
136			{
137			return $this->declaringFunction;
138			}
139
140
141			/**
142			* {@inheritdoc}
143			*/
144			public function getDeclaringFunctionName()
145			{
146			return $this->declaringFunction->getName();
147			}
148
149
150			/**
151			* {@inheritdoc}
152			*/
153			public function getStartLine()
154			{
155			return $this->declaringFunction->getStartLine();
156			}
157
158
159			/**
160			* {@inheritdoc}
161			*/
162			public function getEndLine()
163			{
164			return $this->declaringFunction->getEndLine();
165			}
166
167
168			/**
169			* {@inheritdoc}
170			*/
171			public function getDocComment()
172			{
173			return '';
174			}
175
176
177			/**
178			* {@inheritdoc}
179			*/
180			public function isDefaultValueAvailable()
181			{
182			return (bool) $this->defaultValueDefinition;
183			}
184
185			/**
186			* {@inheritdoc}
187			*/
188			public function getDefaultValueDefinition()
189			{
190			return $this->defaultValueDefinition;
			0 ignored issues – show Bug Best Practice introduced 2016-09-29 12:10 UTC by Report Bug Copy Issue Report The return type of `return $this->defaultValueDefinition;` (`boolean`) is incompatible with the return type declared by the interface `ApiGen\Contracts\Parser\...tDefaultValueDefinition` of type `string`. 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 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('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...
191			}
192
193
194			/**
195			* {@inheritdoc}
196			*/
197			public function getPosition()
198			{
199			return $this->position;
200			}
201
202
203			/**
204			* {@inheritdoc}
205			*/
206			public function isArray()
207			{
208			return TokenReflection\ReflectionParameter::ARRAY_TYPE_HINT === $this->typeHint;
209			}
210
211
212			/**
213			* {@inheritdoc}
214			*/
215			public function isCallable()
216			{
217			return TokenReflection\ReflectionParameter::CALLABLE_TYPE_HINT === $this->typeHint;
218			}
219
220
221			/**
222			* {@inheritdoc}
223			*/
224			public function getClass()
225			{
226			$className = $this->getClassName();
227			return $className === null ? null : $this->getParsedClasses()[$className];
228			}
229
230
231			/**
232			* {@inheritdoc}
233			*/
234			public function getClassName()
235			{
236			if ($this->isArray() \|\| $this->isCallable()) {
237			return null;
238			}
239			if (isset($this->getParsedClasses()[$this->typeHint])) {
240			return $this->typeHint;
241			}
242
243			return null;
244			}
245
246
247			/**
248			* {@inheritdoc}
249			*/
250			public function allowsNull()
251			{
252			if ($this->isArray() \|\| $this->isCallable()) {
253			return strtolower($this->defaultValueDefinition) === 'null';
254			}
255
256			return ! empty($this->defaultValueDefinition);
257			}
258
259
260			/**
261			* {@inheritdoc}
262			*/
263			public function isOptional()
264			{
265			return $this->isDefaultValueAvailable();
266			}
267
268
269			/**
270			* {@inheritdoc}
271			*/
272			public function isPassedByReference()
273			{
274			return $this->passedByReference;
275			}
276
277
278			/**
279			* {@inheritdoc}
280			*/
281			public function canBePassedByValue()
282			{
283			return false;
284			}
285
286
287			/**
288			* {@inheritdoc}
289			*/
290			public function isUnlimited()
291			{
292			return $this->unlimited;
293			}
294			}
295

apigen / ApiGen

GitHub Access Token became invalid

Pull Request — master (#755)

getDefaultValueDefinition() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like