ClassDefinition::setFilepath() - Code Metrics - Inspection of "Merge pull request #92 from ddmler/tests-method-ca..." - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 6ab7bd...834806 )

by Дмитрий

created 2016-09-06 13:44 UTC

ClassDefinition::setFilepath() A

↳ Parent: ClassDefinition

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

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

<?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 $name
     * @return bool
     */
    public function hasConst($name)
    {
        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	389	public function __construct($name, $type)
72		{
73	389	$this->name = $name;
74	389	$this->type = $type;
75	389	}
76
77		/**
78		* @param ClassMethod $methodDefintion
79		*/
80	13	public function addMethod(ClassMethod $methodDefintion)
81		{
82	13	$this->methods[$methodDefintion->getName()] = $methodDefintion;
83	13	}
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		public function addConst(Node\Stmt\ClassConst $const)
97		{
98		$this->constants[$const->consts[0]->name] = $const;
99		}
100
101		/**
102		* @param Context $context
103		* @return $this
104		*/
105	12	public function compile(Context $context)
106		{
107	12	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	12	$this->compiled = true;
112	12	$context->setFilepath($this->filepath);
113	12	$context->setScope($this);
114
115	12	foreach ($this->methods as $method) {
116	12	$context->clearSymbols();
117
118	12	if (!$method->isStatic()) {
119	12	$thisPtr = new Variable('this', $this, CompiledExpression::OBJECT);
120	12	$thisPtr->incGets();
121	12	$context->addVariable($thisPtr);
122	12	}
123
124	12	$method->compile($context);
125
126	12	$symbols = $context->getSymbols();
127	12	if (count($symbols) > 0) {
128	12	foreach ($symbols as $name => $variable) {
129	12	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	12	}
140	12	}
141	12	}
142
143	12	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 $name
167		* @return bool
168		*/
169		public function hasConst($name)
170		{
171		return isset($this->constants[$name]);
172		}
173
174		/**
175		* @param $name
176		* @param boolean\|false $inherit
177		* @return ClassMethod\|null
178		*/
179	1	public function getMethod($name, $inherit = false)
180		{
181	1	if (isset($this->methods[$name])) {
182	1	return $this->methods[$name];
183		}
184
185		if ($inherit && $this->extendsClassDefinition) {
186		return $this->extendsClassDefinition->getMethod($name, $inherit);
187		}
188
189		return null;
190		}
191
192		/**
193		* @param $name
194		* @param bool $inherit
195		* @return bool
196		*/
197	1	public function hasProperty($name, $inherit = false)
198		{
199	1	if (isset($this->properties[$name])) {
200	1	return isset($this->properties[$name]);
201		}
202
203	1	return $inherit && $this->extendsClassDefinition && $this->extendsClassDefinition->hasProperty($name, true);
204		}
205
206		/**
207		* @param string $name
208		* @param bool $inherit
209		* @return Node\Stmt\Property
210		*/
211		public function getProperty($name, $inherit = false)
212		{
213		assert($this->hasProperty($name, $inherit));
214
215		if (isset($this->properties[$name])) {
216		return $this->properties[$name];
217		}
218
219		if ($inherit && $this->extendsClassDefinition) {
220		return $this->extendsClassDefinition->getProperty($name, true);
221		}
222
223		return null;
224		}
225
226		/**
227		* @return string
228		*/
229	12	public function getFilepath()
230		{
231	12	return $this->filepath;
232		}
233
234		/**
235		* @param string $filepath
236		*/
237	12	public function setFilepath($filepath)
238		{
239	12	$this->filepath = $filepath;
240	12	}
241
242		/**
243		* @return bool
244		*/
245		public function isAbstract()
246		{
247		return (bool) ($this->type & Node\Stmt\Class_::MODIFIER_ABSTRACT);
248		}
249
250		/**
251		* @param null\|string $extendsClass
252		*/
253		public function setExtendsClass($extendsClass)
254		{
255		$this->extendsClass = $extendsClass;
256		}
257
258		/**
259		* @return null\|ClassDefinition
260		*/
261		public function getExtendsClassDefinition()
262		{
263		return $this->extendsClassDefinition;
264		}
265
266		/**
267		* @param ClassDefinition $extendsClassDefinition
268		*/
269		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...
270		{
271		$this->extendsClassDefinition = $extendsClassDefinition;
272		}
273
274		/**
275		* @param array $interface
276		*/
277		public function addInterface($interface)
278		{
279		$this->interfaces[] = $interface;
280		}
281
282		/**
283		* @return null\|string
284		*/
285	12	public function getExtendsClass()
286		{
287	12	return $this->extendsClass;
288		}
289		}
290

ovr / phpsa

Push — master ( 6ab7bd...834806 )

ClassDefinition::setFilepath() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like