ClassDefinition::getFilepath() - Code Metrics - Inspection of "[Defintion] Protect to recompile" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d7ac84...935cf2 )

by Дмитрий

created 2015-12-20 20:32 UTC

ClassDefinition::getFilepath() A

↳ Parent: ClassDefinition

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

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

<?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, true)) {
            $method = $this->extendsClassDefinition->getMethod($name);
            return $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
     */
    public function getMethod($name, $inherit = false)
    {
        if (isset($this->methods[$name])) {
            return $this->methods[$name];
        }

        return $inherit && $this->extendsClassDefinition && $this->extendsClassDefinition->getMethod($name, 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());
}
    }

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

    /**
     * @param $name
     * @return CompiledExpression
     */
    public function getProperty($name)
    {
        assert($this->hasProperty($name));
        return $this->properties[$name];
    }

    /**
     * @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 2015-11-22 15:25 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	370	public function __construct($name, $type)
72		{
73	370	$this->name = $name;
74	370	$this->type = $type;
75	370	}
76
77		/**
78		* @param ClassMethod $methodDefintion
79		*/
80	1	public function addMethod(ClassMethod $methodDefintion)
81		{
82	1	$this->methods[$methodDefintion->getName()] = $methodDefintion;
83	1	}
84
85		/**
86		* @param Node\Stmt\Property $property
87		*/
88	1	public function addProperty(Node\Stmt\Property $property)
89		{
90	1	$this->properties[$property->props[0]->name] = $property;
91	1	}
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		public function compile(Context $context)
106		{
107		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		$this->compiled = true;
112		$context->setFilepath($this->filepath);
113		$context->setScope($this);
114
115		foreach ($this->methods as $method) {
116		$context->clearSymbols();
117
118		if (!$method->isStatic()) {
119		$thisPtr = new Variable('this', $this, CompiledExpression::OBJECT);
120		$thisPtr->incGets();
121		$context->addVariable($thisPtr);
122		}
123
124		$method->compile($context);
125
126		$symbols = $context->getSymbols();
127		if (count($symbols) > 0) {
128		foreach ($symbols as $name => $variable) {
129		if ($variable->isUnused()) {
130		$context->warning(
131		'unused-' . $variable->getSymbolType(),
132		sprintf(
133		'Unused ' . $variable->getSymbolType() . ' $%s in method %s()',
134		$variable->getName(),
135		$method->getName()
136		)
137		);
138		}
139		}
140		}
141		}
142
143		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, true)) {
158		$method = $this->extendsClassDefinition->getMethod($name);
159		return $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
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		return $inherit && $this->extendsClassDefinition && $this->extendsClassDefinition->getMethod($name, true);
		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 $inherit && $this...getMethod($name, true);` (`boolean`) is incompatible with the return type documented by `PHPSA\Definition\ClassDefinition::getMethod` of type `PHPSA\Definition\ClassMethod`. 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...
186		}
187
188		/**
189		* @param $name
190		* @return bool
191		*/
192	1	public function hasProperty($name)
193		{
194	1	return isset($this->properties[$name]);
195		}
196
197		/**
198		* @param $name
199		* @return CompiledExpression
200		*/
201		public function getProperty($name)
202		{
203		assert($this->hasProperty($name));
204		return $this->properties[$name];
205		}
206
207		/**
208		* @return string
209		*/
210		public function getFilepath()
211		{
212		return $this->filepath;
213		}
214
215		/**
216		* @param string $filepath
217		*/
218		public function setFilepath($filepath)
219		{
220		$this->filepath = $filepath;
221		}
222
223		/**
224		* @return bool
225		*/
226		public function isAbstract()
227		{
228		return (bool) ($this->type & Node\Stmt\Class_::MODIFIER_ABSTRACT);
229		}
230
231		/**
232		* @param null\|string $extendsClass
233		*/
234		public function setExtendsClass($extendsClass)
235		{
236		$this->extendsClass = $extendsClass;
237		}
238
239		/**
240		* @return null\|ClassDefinition
241		*/
242		public function getExtendsClassDefinition()
243		{
244		return $this->extendsClassDefinition;
245		}
246
247		/**
248		* @param ClassDefinition $extendsClassDefinition
249		*/
250		public function setExtendsClassDefinition(ClassDefinition $extendsClassDefinition)
		0 ignored issues – show Comprehensibility Naming introduced 2015-11-22 15:25 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...
251		{
252		$this->extendsClassDefinition = $extendsClassDefinition;
253		}
254
255		/**
256		* @param array $interface
257		*/
258		public function addInterface($interface)
259		{
260		$this->interfaces[] = $interface;
261		}
262
263		/**
264		* @return null\|string
265		*/
266		public function getExtendsClass()
267		{
268		return $this->extendsClass;
269		}
270		}
271

ovr / phpsa

Push — master ( d7ac84...935cf2 )

ClassDefinition::getFilepath() A

Complexity

Size

Duplication

Code Coverage

Duplication Side-by-Side

Filter issues like