ClassDefinition - Code Metrics - Inspection of "Fix constant existence check" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#88)

by Kévin

created 2016-09-06 16:58 UTC

ClassDefinition B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	278
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	8

Test Coverage

Coverage

75%

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
c	2
b	1
f	0
dl	0
loc	278
ccs	69
cts	92
cp	0.75
rs	8.295
wmc	42
lcom	3
cbo	8

18 Methods

Rating	Name	Size	Complexity
A	__construct()	5	1
A	addMethod()	4	1
A	addProperty()	4	1
B	hasMethod()	13	7
C	compile()	40	7
A	addConst()	4	1
A	hasConst()	8	4
A	getMethod()	12	4
A	hasProperty()	8	4
A	getProperty()	14	4
A	getFilepath()	4	1
A	setFilepath()	4	1
A	isAbstract()	4	1
A	setExtendsClass()	4	1
A	getExtendsClassDefinition()	4	1
A	setExtendsClassDefinition()	4	1
A	addInterface()	4	1
A	getExtendsClass()	4	1

How to fix Complexity

<?php
/**
 * @author Patsura Dmitry https://github.com/ovr <[email protected]>
 */

namespace PHPSA\Definition;

use PHPSA\CompiledExpression;
use PHPSA\Context;
use PhpParser\Node;
use PHPSA\Variable;

/**
 * Class ClassDefinition
 * @package PHPSA\Definition
 */
class ClassDefinition extends ParentDefinition
{
    /**
     * @var int
     */
    protected $type;

    /**
     * Class methods
     *
     * @var ClassMethod[]
     */
    protected $methods = array();

    /**
     * Class properties
     *
     * @var Node\Stmt\Property[]
     */
    protected $properties = array();

    /**
     * Class constants
     *
     * @var Node\Stmt\Const_[]
     */
    protected $constants = array();

    /**
     * @todo Use Finder
     *
     * @var string
     */
    protected $filepath;

    /**
     * @var string|null
     */
    protected $extendsClass;

    /**
     * @var ClassDefinition|null
     */
    protected $extendsClassDefinition;


    /**
     * @var array
     */
    protected $interfaces = array();

    /**
     * @param string $name
     * @param integer $type
     */
    public function __construct($name, $type)
    {
        $this->name = $name;
        $this->type = $type;
    }

    /**
     * @param ClassMethod $methodDefintion
     */
    public function addMethod(ClassMethod $methodDefintion)
    {
        $this->methods[$methodDefintion->getName()] = $methodDefintion;
    }

    /**
     * @param Node\Stmt\Property $property
     */
    public function addProperty(Node\Stmt\Property $property)
    {
        $this->properties[$property->props[0]->name] = $property;
    }

    /**
     * @param Node\Stmt\ClassConst $const
     */
    public function addConst(Node\Stmt\ClassConst $const)
    {
        $this->constants[$const->consts[0]->name] = $const;
    }

    /**
     * @param Context $context
     * @return $this
     */
    public function compile(Context $context)
    {
        if ($this->compiled) {
            return true;
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());
}
        }

        $this->compiled = true;
        $context->setFilepath($this->filepath);
        $context->setScope($this);

        foreach ($this->methods as $method) {
            $context->clearSymbols();

            if (!$method->isStatic()) {
                $thisPtr = new Variable('this', $this, CompiledExpression::OBJECT);
                $thisPtr->incGets();
                $context->addVariable($thisPtr);
            }

            $method->compile($context);

            $symbols = $context->getSymbols();
            if (count($symbols) > 0) {
                foreach ($symbols as $name => $variable) {
                    if ($variable->isUnused()) {
                        $context->warning(
                            'unused-' . $variable->getSymbolType(),
                            sprintf(
                                'Unused ' . $variable->getSymbolType() . ' $%s in method %s()',
                                $variable->getName(),
                                $method->getName()
                            )
                        );
                    }
                }
            }
        }

        return $this;
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());
}
    }

    /**
     * @param string $name
     * @param boolean|false $inherit
     * @return bool
     */
    public function hasMethod($name, $inherit = false)
    {
        if (isset($this->methods[$name])) {
            return true;
        }

        if ($inherit && $this->extendsClassDefinition && $this->extendsClassDefinition->hasMethod($name, $inherit)) {
            $method = $this->extendsClassDefinition->getMethod($name, $inherit);
            return $method && ($method->isPublic() || $method->isProtected());
        }

        return false;
    }

    /**
     * @param string $name
     * @param bool $inherit
     * @return bool
     */
    public function hasConst($name, $inherit = false)
    {
        if ($inherit && $this->extendsClassDefinition && $this->extendsClassDefinition->hasConst($name, $inherit)) {
            return true;
        }

        return isset($this->constants[$name]);
    }

    /**
     * @param $name
     * @param boolean|false $inherit
     * @return ClassMethod|null
     */
    public function getMethod($name, $inherit = false)
    {
        if (isset($this->methods[$name])) {
            return $this->methods[$name];
        }

        if ($inherit && $this->extendsClassDefinition) {
            return $this->extendsClassDefinition->getMethod($name, $inherit);
        }

        return null;
    }

    /**
     * @param $name
     * @param bool $inherit
     * @return bool
     */
    public function hasProperty($name, $inherit = false)
    {
        if (isset($this->properties[$name])) {
            return isset($this->properties[$name]);
        }

        return $inherit && $this->extendsClassDefinition && $this->extendsClassDefinition->hasProperty($name, true);
    }

    /**
     * @param string $name
     * @param bool $inherit
     * @return Node\Stmt\Property
     */
    public function getProperty($name, $inherit = false)
    {
        assert($this->hasProperty($name, $inherit));

        if (isset($this->properties[$name])) {
            return $this->properties[$name];
        }

        if ($inherit && $this->extendsClassDefinition) {
            return $this->extendsClassDefinition->getProperty($name, true);
        }

        return null;
    }

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

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

    /**
     * @return bool
     */
    public function isAbstract()
    {
        return (bool) ($this->type & Node\Stmt\Class_::MODIFIER_ABSTRACT);
    }

    /**
     * @param null|string $extendsClass
     */
    public function setExtendsClass($extendsClass)
    {
        $this->extendsClass = $extendsClass;
    }

    /**
     * @return null|ClassDefinition
     */
    public function getExtendsClassDefinition()
    {
        return $this->extendsClassDefinition;
    }

    /**
     * @param ClassDefinition $extendsClassDefinition
     */
    public function setExtendsClassDefinition(ClassDefinition $extendsClassDefinition)

    {
        $this->extendsClassDefinition = $extendsClassDefinition;
    }

    /**
     * @param array $interface
     */
    public function addInterface($interface)
    {
        $this->interfaces[] = $interface;
    }

    /**
     * @return null|string
     */
    public function getExtendsClass()
    {
        return $this->extendsClass;
    }
}


1		<?php
2		/**
3		* @author Patsura Dmitry https://github.com/ovr <[email protected]>
4		*/
5
6		namespace PHPSA\Definition;
7
8		use PHPSA\CompiledExpression;
9		use PHPSA\Context;
10		use PhpParser\Node;
11		use PHPSA\Variable;
12
13		/**
14		* Class ClassDefinition
15		* @package PHPSA\Definition
16		*/
17		class ClassDefinition extends ParentDefinition
18		{
19		/**
20		* @var int
21		*/
22		protected $type;
23
24		/**
25		* Class methods
26		*
27		* @var ClassMethod[]
28		*/
29		protected $methods = array();
30
31		/**
32		* Class properties
33		*
34		* @var Node\Stmt\Property[]
35		*/
36		protected $properties = array();
37
38		/**
39		* Class constants
40		*
41		* @var Node\Stmt\Const_[]
42		*/
43		protected $constants = array();
44
45		/**
46		* @todo Use Finder
47		*
48		* @var string
49		*/
50		protected $filepath;
51
52		/**
53		* @var string\|null
54		*/
55		protected $extendsClass;
56
57		/**
58		* @var ClassDefinition\|null
59		*/
60		protected $extendsClassDefinition;
		0 ignored issues – show Comprehensibility Naming introduced 2016-02-06 15:22 UTC by Report Bug Copy Issue Report The variable name `$extendsClassDefinition` exceeds the maximum configured length of `20`. Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose. Loading history...
61
62		/**
63		* @var array
64		*/
65		protected $interfaces = array();
66
67		/**
68		* @param string $name
69		* @param integer $type
70		*/
71	393	public function __construct($name, $type)
72		{
73	393	$this->name = $name;
74	393	$this->type = $type;
75	393	}
76
77		/**
78		* @param ClassMethod $methodDefintion
79		*/
80	15	public function addMethod(ClassMethod $methodDefintion)
81		{
82	15	$this->methods[$methodDefintion->getName()] = $methodDefintion;
83	15	}
84
85		/**
86		* @param Node\Stmt\Property $property
87		*/
88	2	public function addProperty(Node\Stmt\Property $property)
89		{
90	2	$this->properties[$property->props[0]->name] = $property;
91	2	}
92
93		/**
94		* @param Node\Stmt\ClassConst $const
95		*/
96	2	public function addConst(Node\Stmt\ClassConst $const)
97		{
98	2	$this->constants[$const->consts[0]->name] = $const;
99	2	}
100
101		/**
102		* @param Context $context
103		* @return $this
104		*/
105	14	public function compile(Context $context)
106		{
107	14	if ($this->compiled) {
108		return true;
		0 ignored issues – show Bug Best Practice introduced 2015-12-20 20:34 UTC by Report Bug Copy Issue Report The return type of `return true;` (`boolean`) is incompatible with the return type documented by `PHPSA\Definition\ClassDefinition::compile` of type `PHPSA\Definition\ClassDefinition`. 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...
109		}
110
111	14	$this->compiled = true;
112	14	$context->setFilepath($this->filepath);
113	14	$context->setScope($this);
114
115	14	foreach ($this->methods as $method) {
116	14	$context->clearSymbols();
117
118	14	if (!$method->isStatic()) {
119	14	$thisPtr = new Variable('this', $this, CompiledExpression::OBJECT);
120	14	$thisPtr->incGets();
121	14	$context->addVariable($thisPtr);
122	14	}
123
124	14	$method->compile($context);
125
126	14	$symbols = $context->getSymbols();
127	14	if (count($symbols) > 0) {
128	14	foreach ($symbols as $name => $variable) {
129	14	if ($variable->isUnused()) {
130	1	$context->warning(
131	1	'unused-' . $variable->getSymbolType(),
132	1	sprintf(
133	1	'Unused ' . $variable->getSymbolType() . ' $%s in method %s()',
134	1	$variable->getName(),
135	1	$method->getName()
136	1	)
137	1	);
138	1	}
139	14	}
140	14	}
141	14	}
142
143	14	return $this;
		0 ignored issues – show Bug Best Practice introduced 2015-11-22 15:25 UTC by Report Bug Copy Issue Report The return type of `return $this;` (`PHPSA\Definition\ClassDefinition`) is incompatible with the return type declared by the abstract method `PHPSA\Definition\AbstractDefinition::compile` of type `boolean`. 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...
144		}
145
146		/**
147		* @param string $name
148		* @param boolean\|false $inherit
149		* @return bool
150		*/
151	1	public function hasMethod($name, $inherit = false)
152		{
153	1	if (isset($this->methods[$name])) {
154	1	return true;
155		}
156
157	1	if ($inherit && $this->extendsClassDefinition && $this->extendsClassDefinition->hasMethod($name, $inherit)) {
158		$method = $this->extendsClassDefinition->getMethod($name, $inherit);
159		return $method && ($method->isPublic() \|\| $method->isProtected());
160		}
161
162	1	return false;
163		}
164
165		/**
166		* @param string $name
167		* @param bool $inherit
168		* @return bool
169		*/
170	2	public function hasConst($name, $inherit = false)
171		{
172	2	if ($inherit && $this->extendsClassDefinition && $this->extendsClassDefinition->hasConst($name, $inherit)) {
173	1	return true;
174		}
175
176	2	return isset($this->constants[$name]);
177		}
178
179		/**
180		* @param $name
181		* @param boolean\|false $inherit
182		* @return ClassMethod\|null
183		*/
184	1	public function getMethod($name, $inherit = false)
185		{
186	1	if (isset($this->methods[$name])) {
187	1	return $this->methods[$name];
188		}
189
190		if ($inherit && $this->extendsClassDefinition) {
191		return $this->extendsClassDefinition->getMethod($name, $inherit);
192		}
193
194		return null;
195		}
196
197		/**
198		* @param $name
199		* @param bool $inherit
200		* @return bool
201		*/
202	1	public function hasProperty($name, $inherit = false)
203		{
204	1	if (isset($this->properties[$name])) {
205	1	return isset($this->properties[$name]);
206		}
207
208	1	return $inherit && $this->extendsClassDefinition && $this->extendsClassDefinition->hasProperty($name, true);
209		}
210
211		/**
212		* @param string $name
213		* @param bool $inherit
214		* @return Node\Stmt\Property
215		*/
216		public function getProperty($name, $inherit = false)
217		{
218		assert($this->hasProperty($name, $inherit));
219
220		if (isset($this->properties[$name])) {
221		return $this->properties[$name];
222		}
223
224		if ($inherit && $this->extendsClassDefinition) {
225		return $this->extendsClassDefinition->getProperty($name, true);
226		}
227
228		return null;
229		}
230
231		/**
232		* @return string
233		*/
234	14	public function getFilepath()
235		{
236	14	return $this->filepath;
237		}
238
239		/**
240		* @param string $filepath
241		*/
242	14	public function setFilepath($filepath)
243		{
244	14	$this->filepath = $filepath;
245	14	}
246
247		/**
248		* @return bool
249		*/
250		public function isAbstract()
251		{
252		return (bool) ($this->type & Node\Stmt\Class_::MODIFIER_ABSTRACT);
253		}
254
255		/**
256		* @param null\|string $extendsClass
257		*/
258		public function setExtendsClass($extendsClass)
259		{
260		$this->extendsClass = $extendsClass;
261		}
262
263		/**
264		* @return null\|ClassDefinition
265		*/
266		public function getExtendsClassDefinition()
267		{
268		return $this->extendsClassDefinition;
269		}
270
271		/**
272		* @param ClassDefinition $extendsClassDefinition
273		*/
274	1	public function setExtendsClassDefinition(ClassDefinition $extendsClassDefinition)
		0 ignored issues – show Comprehensibility Naming introduced 2016-02-06 15:22 UTC by Report Bug Copy Issue Report The variable name `$extendsClassDefinition` exceeds the maximum configured length of `20`. Very long variable names usually make code harder to read. It is therefore recommended not to make variable names too verbose. Loading history...
275		{
276	1	$this->extendsClassDefinition = $extendsClassDefinition;
277	1	}
278
279		/**
280		* @param array $interface
281		*/
282		public function addInterface($interface)
283		{
284		$this->interfaces[] = $interface;
285		}
286
287		/**
288		* @return null\|string
289		*/
290	14	public function getExtendsClass()
291		{
292	14	return $this->extendsClass;
293		}
294		}
295

ovr / phpsa

Pull Request — master (#88)

ClassDefinition B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

18 Methods

How to fix Complexity

Complex Class

Duplication Side-by-Side

Filter issues like