Context::addSymbol() - Code Metrics - Inspection of "Discourage use of variable variables" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#87)

by Kévin

created 2016-09-04 15:27 UTC

Context::addSymbol() A

↳ Parent: Context

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

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

namespace PHPSA;

use PHPSA\Compiler\Expression;
use PHPSA\Compiler\GlobalVariable;
use PHPSA\Definition\AbstractDefinition;
use PHPSA\Definition\ParentDefinition;
use Symfony\Component\Console\Output\OutputInterface;
use Webiny\Component\EventManager\EventManager;

class Context
{
    /**
     * For FunctionDefinition it's null, use scopePointer
     *
     * @var ParentDefinition|null
     */
    public $scope;

    /**
     * @var AliasManager
     */
    public $aliasManager;

    /**
     * @var Application
     */
    public $application;

    /**
     * @var string|integer
     */
    public $currentBranch;

    /**
     * @var OutputInterface
     */
    public $output;

    /**
     * @var Variable[]
     */
    protected $symbols = array();

    /**
     * @var ScopePointer|null
     */
    public $scopePointer;

    /**
     * @var string
     */
    protected $filepath;

    /**
     * @var EventManager
     */
    protected $eventManager;

    /**
     * Construct our Context with all needed information
     *
     * @param OutputInterface $output
     * @param Application $application
     * @param EventManager $eventManager
     */
    public function __construct(OutputInterface $output, Application $application, EventManager $eventManager)
    {
        $this->output = $output;
        $this->application = $application;

        $this->initGlobals();
        $this->eventManager = $eventManager;
    }

    /**
     * @return Expression
     */
    public function getExpressionCompiler()
    {
        return new Expression($this, $this->eventManager);
    }

    public function initGlobals()
    {
        /**
         * http://php.net/manual/language.variables.superglobals.php
         */
        $this->addVariable(new GlobalVariable('GLOBALS', array(), CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_SERVER', array(), CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_GET', array(), CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_POST', array(), CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_FILES', array(), CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_COOKIE', array(), CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_SESSION', array(), CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_REQUEST', array(), CompiledExpression::ARR));
        $this->addVariable(new GlobalVariable('_ENV', array(), CompiledExpression::ARR));
    }

    /**
     * @param string $name
     * @return Variable
     */
    public function addSymbol($name)
    {
        $variable = new Variable($name);
        $this->symbols[$name] = $variable;

        return $variable;
    }

    /**
     * @param Variable $variable
     * @return bool
     */
    public function addVariable(Variable $variable)
    {
        if (!is_string($variable->getName())) {
            return false;
        }

        $this->symbols[$variable->getName()] = $variable;

        return true;
    }

    /**
     * Clear prevent context
     */
    public function clear()
    {
        $this->symbols = array();
        $this->scope = null;
        $this->scopePointer = null;
        $this->currentBranch = null;
        $this->aliasManager = null;

        $this->initGlobals();
    }

    public function clearSymbols()
    {
        unset($this->symbols);
        $this->symbols = array();
    }

    /**
     * @param $name
     * @return Variable|null
     */
    public function getSymbol($name)
    {
        if (!is_string($name)) {
            return null;
        }

        return isset($this->symbols[$name]) ? $this->symbols[$name] : null;
    }

    /**
     * @param string $type
     * @param string $message
     * @return bool
     */
    public function warning($type, $message)
    {
        $this->output
            ->writeln('<comment>Warning:  ' . $message . ' in ' . $this->filepath . '  [' . $type . ']</comment>');

        $this->output->writeln('');

        return true;
    }

    /**
     * @param string $type
     * @param string $message
     * @param \PhpParser\NodeAbstract $expr
     * @param int $status
     * @return bool
     */
    public function notice($type, $message, \PhpParser\NodeAbstract $expr, $status = Check::CHECK_SAFE)

    {
        $filepath = $this->filepath;
        $code = file($filepath);

        $this->output->writeln('<comment>Notice:  ' . $message . " in {$filepath} on {$expr->getLine()} [{$type}]</comment>");
        $this->output->writeln('');

        if ($this->application->getConfiguration()->valueIsTrue('blame')) {
            exec("git blame --show-email -L {$expr->getLine()},{$expr->getLine()} " . $filepath, $result);
            if ($result && isset($result[0])) {
                $result[0] = trim($result[0]);

                $this->output->writeln("<comment>\t {$result[0]}</comment>");
            }
        } else {
            $code = trim($code[$expr->getLine() - 1]);
            $this->output->writeln("<comment>\t {$code} </comment>");
        }

        $this->output->writeln('');

        $this->application->getIssuesCollector()
            ->addIssue($type, $message, basename($this->filepath), $expr->getLine() - 1);

        return true;
    }

    /**
     * @param \PhpParser\Error $exception
     * @param string $filepath
     * @return bool
     */
    public function sytaxError(\PhpParser\Error $exception, $filepath)
    {
        $code = file($filepath);

        $this->output->writeln('<error>Syntax error:  ' . $exception->getMessage() . " in {$filepath} </error>");
        $this->output->writeln('');

        $this->application->getIssuesCollector()
            ->addIssue('syntax-error', 'syntax-error', $filepath, $exception->getStartLine() - 2);

        $code = trim($code[($exception->getStartLine()-2)]);
        $this->output->writeln("<comment>\t {$code} </comment>");

        return true;
    }

    /**
     * @return Variable[]
     */
    public function getSymbols()
    {
        return $this->symbols;
    }

    /**
     * @param AbstractDefinition $scope
     */
    public function setScope(AbstractDefinition $scope = null)
    {
        $this->scope = $scope;
class Id
{
    public $id;

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

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
    }

    public function debug($message, \PhpParser\Node $expr = null)
    {
        if ($this->output->isDebug()) {
            $this->output->writeln('[DEBUG] ' . $message);
            $this->output->write($this->filepath);

            if ($expr) {
                $this->output->write(':' . $expr->getLine());
            }

            $this->output->writeln('');
        }
    }

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

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

    /**
     * @return integer
     */
    public function getCurrentBranch()
    {
        return $this->currentBranch;
    }

    /**
     * @param int|string $currentBranch
     */
    public function setCurrentBranch($currentBranch)
    {
        $this->currentBranch = $currentBranch;
    }

    /**
     * @param Variable $variable
     * @param $type
     * @param $value
     */
    public function modifyReferencedVariables(Variable $variable, $type, $value)
    {
        foreach ($this->symbols as $symbol) {
            $referencedTo = $symbol->getReferencedTo();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
            if ($referencedTo) {
                if ($referencedTo === $variable) {
                    $symbol->modify($type, $value);
                }
            }
        }
    }

    /**
     * @return EventManager
     */
    public function getEventManager()
    {
        return $this->eventManager;
    }
}


1		<?php
2		/**
3		* @author Patsura Dmitry https://github.com/ovr <[email protected]>
4		*/
5
6		namespace PHPSA;
7
8		use PHPSA\Compiler\Expression;
9		use PHPSA\Compiler\GlobalVariable;
10		use PHPSA\Definition\AbstractDefinition;
11		use PHPSA\Definition\ParentDefinition;
12		use Symfony\Component\Console\Output\OutputInterface;
13		use Webiny\Component\EventManager\EventManager;
14
15		class Context
16		{
17		/**
18		* For FunctionDefinition it's null, use scopePointer
19		*
20		* @var ParentDefinition\|null
21		*/
22		public $scope;
23
24		/**
25		* @var AliasManager
26		*/
27		public $aliasManager;
28
29		/**
30		* @var Application
31		*/
32		public $application;
33
34		/**
35		* @var string\|integer
36		*/
37		public $currentBranch;
38
39		/**
40		* @var OutputInterface
41		*/
42		public $output;
43
44		/**
45		* @var Variable[]
46		*/
47		protected $symbols = array();
48
49		/**
50		* @var ScopePointer\|null
51		*/
52		public $scopePointer;
53
54		/**
55		* @var string
56		*/
57		protected $filepath;
58
59		/**
60		* @var EventManager
61		*/
62		protected $eventManager;
63
64		/**
65		* Construct our Context with all needed information
66		*
67		* @param OutputInterface $output
68		* @param Application $application
69		* @param EventManager $eventManager
70		*/
71	384	public function __construct(OutputInterface $output, Application $application, EventManager $eventManager)
72		{
73	384	$this->output = $output;
74	384	$this->application = $application;
75
76	384	$this->initGlobals();
77	384	$this->eventManager = $eventManager;
78	384	}
79
80		/**
81		* @return Expression
82		*/
83	377	public function getExpressionCompiler()
84		{
85	377	return new Expression($this, $this->eventManager);
86		}
87
88	384	public function initGlobals()
89		{
90		/**
91		* http://php.net/manual/language.variables.superglobals.php
92		*/
93	384	$this->addVariable(new GlobalVariable('GLOBALS', array(), CompiledExpression::ARR));
94	384	$this->addVariable(new GlobalVariable('_SERVER', array(), CompiledExpression::ARR));
95	384	$this->addVariable(new GlobalVariable('_GET', array(), CompiledExpression::ARR));
96	384	$this->addVariable(new GlobalVariable('_POST', array(), CompiledExpression::ARR));
97	384	$this->addVariable(new GlobalVariable('_FILES', array(), CompiledExpression::ARR));
98	384	$this->addVariable(new GlobalVariable('_COOKIE', array(), CompiledExpression::ARR));
99	384	$this->addVariable(new GlobalVariable('_SESSION', array(), CompiledExpression::ARR));
100	384	$this->addVariable(new GlobalVariable('_REQUEST', array(), CompiledExpression::ARR));
101	384	$this->addVariable(new GlobalVariable('_ENV', array(), CompiledExpression::ARR));
102	384	}
103
104		/**
105		* @param string $name
106		* @return Variable
107		*/
108		public function addSymbol($name)
109		{
110		$variable = new Variable($name);
111		$this->symbols[$name] = $variable;
112
113		return $variable;
114		}
115
116		/**
117		* @param Variable $variable
118		* @return bool
119		*/
120	384	public function addVariable(Variable $variable)
121		{
122	384	if (!is_string($variable->getName())) {
123	2	return false;
124		}
125
126	384	$this->symbols[$variable->getName()] = $variable;
127
128	384	return true;
129		}
130
131		/**
132		* Clear prevent context
133		*/
134	10	public function clear()
135		{
136	10	$this->symbols = array();
137	10	$this->scope = null;
138	10	$this->scopePointer = null;
139	10	$this->currentBranch = null;
140	10	$this->aliasManager = null;
141
142	10	$this->initGlobals();
143	10	}
144
145	10	public function clearSymbols()
146		{
147	10	unset($this->symbols);
148	10	$this->symbols = array();
149	10	}
150
151		/**
152		* @param $name
153		* @return Variable\|null
154		*/
155	15	public function getSymbol($name)
156		{
157	15	if (!is_string($name)) {
158	2	return null;
159		}
160
161	14	return isset($this->symbols[$name]) ? $this->symbols[$name] : null;
162		}
163
164		/**
165		* @param string $type
166		* @param string $message
167		* @return bool
168		*/
169	1	public function warning($type, $message)
170		{
171	1	$this->output
172	1	->writeln('<comment>Warning: ' . $message . ' in ' . $this->filepath . ' [' . $type . ']</comment>');
173
174	1	$this->output->writeln('');
175
176	1	return true;
177		}
178
179		/**
180		* @param string $type
181		* @param string $message
182		* @param \PhpParser\NodeAbstract $expr
183		* @param int $status
184		* @return bool
185		*/
186	10	public function notice($type, $message, \PhpParser\NodeAbstract $expr, $status = Check::CHECK_SAFE)
		0 ignored issues – show Unused Code introduced 2016-01-16 20:22 UTC by Report Bug Copy Issue Report The parameter `$status` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
187		{
188	10	$filepath = $this->filepath;
189	10	$code = file($filepath);
190
191	10	$this->output->writeln('<comment>Notice: ' . $message . " in {$filepath} on {$expr->getLine()} [{$type}]</comment>");
192	10	$this->output->writeln('');
193
194	10	if ($this->application->getConfiguration()->valueIsTrue('blame')) {
195		exec("git blame --show-email -L {$expr->getLine()},{$expr->getLine()} " . $filepath, $result);
196		if ($result && isset($result[0])) {
197		$result[0] = trim($result[0]);
198
199		$this->output->writeln("<comment>\t {$result[0]}</comment>");
200		}
201		} else {
202	10	$code = trim($code[$expr->getLine() - 1]);
203	10	$this->output->writeln("<comment>\t {$code} </comment>");
204		}
205
206	10	$this->output->writeln('');
207
208	10	$this->application->getIssuesCollector()
209	10	->addIssue($type, $message, basename($this->filepath), $expr->getLine() - 1);
210
211	10	return true;
212		}
213
214		/**
215		* @param \PhpParser\Error $exception
216		* @param string $filepath
217		* @return bool
218		*/
219		public function sytaxError(\PhpParser\Error $exception, $filepath)
220		{
221		$code = file($filepath);
222
223		$this->output->writeln('<error>Syntax error: ' . $exception->getMessage() . " in {$filepath} </error>");
224		$this->output->writeln('');
225
226		$this->application->getIssuesCollector()
227		->addIssue('syntax-error', 'syntax-error', $filepath, $exception->getStartLine() - 2);
228
229		$code = trim($code[($exception->getStartLine()-2)]);
230		$this->output->writeln("<comment>\t {$code} </comment>");
231
232		return true;
233		}
234
235		/**
236		* @return Variable[]
237		*/
238	10	public function getSymbols()
239		{
240	10	return $this->symbols;
241		}
242
243		/**
244		* @param AbstractDefinition $scope
245		*/
246	384	public function setScope(AbstractDefinition $scope = null)
247		{
248	384	$this->scope = $scope;
		0 ignored issues – show Documentation Bug introduced 2015-11-22 15:25 UTC by Report Bug Copy Issue Report It seems like `$scope` can also be of type `object<PHPSA\Definition\AbstractDefinition>`. However, the property `$scope` is declared as type `object<PHPSA\Definition\ParentDefinition>\|null`. Maybe add an additional type check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly. For example, imagine you have a variable `$accountId` that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the `id` property of an instance of the `Account` class. This class holds a proper account, so the id value must no longer be false. Either this assignment is in error or a type check should be added for that assignment. class Id { public $id; public function __construct($id) { $this->id = $id; } } class Account { /** @var Id $id */ public $id; } $account_id = false; if (starsAreRight()) { $account_id = new Id(42); } $account = new Account(); if ($account instanceof Id) { $account->id = $account_id; } Loading history...
249	384	}
250
251	10	public function debug($message, \PhpParser\Node $expr = null)
252		{
253	10	if ($this->output->isDebug()) {
254		$this->output->writeln('[DEBUG] ' . $message);
255		$this->output->write($this->filepath);
256
257		if ($expr) {
258		$this->output->write(':' . $expr->getLine());
259		}
260
261		$this->output->writeln('');
262		}
263	10	}
264
265		/**
266		* @return string
267		*/
268		public function getFilepath()
269		{
270		return $this->filepath;
271		}
272
273		/**
274		* @param string $filepath
275		*/
276	10	public function setFilepath($filepath)
277		{
278	10	$this->filepath = $filepath;
279	10	}
280
281		/**
282		* @return integer
283		*/
284	6	public function getCurrentBranch()
285		{
286	6	return $this->currentBranch;
287		}
288
289		/**
290		* @param int\|string $currentBranch
291		*/
292		public function setCurrentBranch($currentBranch)
293		{
294		$this->currentBranch = $currentBranch;
295		}
296
297		/**
298		* @param Variable $variable
299		* @param $type
300		* @param $value
301		*/
302	2	public function modifyReferencedVariables(Variable $variable, $type, $value)
303		{
304	2	foreach ($this->symbols as $symbol) {
305	2	$referencedTo = $symbol->getReferencedTo();
		0 ignored issues – show Bug introduced 2016-05-17 11:01 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$referencedTo` is correct as `$symbol->getReferencedTo()` (which targets `PHPSA\Variable::getReferencedTo()`) seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
306	2	if ($referencedTo) {
307	2	if ($referencedTo === $variable) {
308	2	$symbol->modify($type, $value);
309	2	}
310	2	}
311	2	}
312	2	}
313
314		/**
315		* @return EventManager
316		*/
317	10	public function getEventManager()
318		{
319	10	return $this->eventManager;
320		}
321		}
322

ovr / phpsa

Pull Request — master (#87)

Context::addSymbol() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like