FinalStaticUsage::pass() - Code Metrics - Inspection of "Add analyzer descriptions" - ovr/phpsa - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#238)

by Enrico

created 2016-10-12 11:13 UTC

FinalStaticUsage::pass() A

↳ Parent: FinalStaticUsage

Complexity

Conditions	4
Paths	3

Size

Total Lines	19
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4.0961

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	4
eloc	11
c	1
b	0
f	0
nc	3
nop	2
dl	0
loc	19
ccs	9
cts	11
cp	0.8182
crap	4.0961
rs	9.2

<?php

namespace PHPSA\Analyzer\Pass\Expression;

use PhpParser\Node\Expr;
use PHPSA\Analyzer\Helper\DefaultMetadataPassTrait;
use PHPSA\Analyzer\Pass\AnalyzerPassInterface;
use PHPSA\Context;
use PHPSA\Definition\ClassDefinition;

class FinalStaticUsage implements AnalyzerPassInterface
{
    use DefaultMetadataPassTrait {
        DefaultMetadataPassTrait::getMetadata as defaultMetadata;
    }

    const DESCRIPTION = 'Checks for use of `static::` inside a final class.';

    /**
     * @param Expr\StaticCall $expr
     * @param Context $context
     * @return bool
     */
    public function pass(Expr\StaticCall $expr, Context $context)
    {
        $classObject = $context->scope->getPointer()->getObject();
        if (!$classObject instanceof ClassDefinition || !$classObject->isFinal()) {
            return false;
        }

        if ($expr->class->getFirst() !== 'static') {
class A
{
    public function foo() { }
}

class B extends A
{
    public function bar() { }
}

/**
 * @param A|B $x
 */
function someFunction($x)
{
    $x->foo(); // This call is fine as the method exists in A and B.
    $x->bar(); // This method only exists in B and might cause an error.
}
            return false;
        }

        $context->notice(
            'error.final-static-usage',
            'Don\'t use static:: in final class',
            $expr
        );

        return true;
    }

    /**
     * @return array
     */
    public function getRegister()
    {
        return [
            Expr\StaticCall::class,
        ];
    }

    /**
     * {@inheritdoc}
     */
    public static function getMetadata()
    {
        $metadata = self::defaultMetadata();
        $metadata->setRequiredPhpVersion('5.3'); //static:: since PHP 5.3

        return $metadata;
    }
}


1		<?php
2
3		namespace PHPSA\Analyzer\Pass\Expression;
4
5		use PhpParser\Node\Expr;
6		use PHPSA\Analyzer\Helper\DefaultMetadataPassTrait;
7		use PHPSA\Analyzer\Pass\AnalyzerPassInterface;
8		use PHPSA\Context;
9		use PHPSA\Definition\ClassDefinition;
10
11		class FinalStaticUsage implements AnalyzerPassInterface
12		{
13		use DefaultMetadataPassTrait {
14		DefaultMetadataPassTrait::getMetadata as defaultMetadata;
15		}
16
17		const DESCRIPTION = 'Checks for use of `static::` inside a final class.';
18
19		/**
20		* @param Expr\StaticCall $expr
21		* @param Context $context
22		* @return bool
23		*/
24	1	public function pass(Expr\StaticCall $expr, Context $context)
25		{
26	1	$classObject = $context->scope->getPointer()->getObject();
27	1	if (!$classObject instanceof ClassDefinition \|\| !$classObject->isFinal()) {
28		return false;
29		}
30
31	1	if ($expr->class->getFirst() !== 'static') {
		0 ignored issues – show Bug introduced 2016-10-05 12:21 UTC by Report Bug Copy Issue Report The method `getFirst` does only exist in `PhpParser\Node\Name`, but not in `PhpParser\Node\Expr`. It seems like the method you are trying to call exists only in some of the possible types. Let’s take a look at an example: class A { public function foo() { } } class B extends A { public function bar() { } } /** * @param A\|B $x / function someFunction($x) { $x->foo(); // This call is fine as the method exists in A and B. $x->bar(); // This method only exists in B and might cause an error. } Available Fixes Add an additional type-check: /* * @param A\|B $x / function someFunction($x) { $x->foo(); if ($x instanceof B) { $x->bar(); } } Only allow a single type to be passed if the variable comes from a parameter: function someFunction(B $x) { /* ... */ } Loading history...
32		return false;
33		}
34
35	1	$context->notice(
36	1	'error.final-static-usage',
37	1	'Don\'t use static:: in final class',
38		$expr
39	1	);
40
41	1	return true;
42		}
43
44		/**
45		* @return array
46		*/
47	1	public function getRegister()
48		{
49		return [
50	1	Expr\StaticCall::class,
51	1	];
52		}
53
54		/**
55		* {@inheritdoc}
56		*/
57	1	public static function getMetadata()
58		{
59	1	$metadata = self::defaultMetadata();
60	1	$metadata->setRequiredPhpVersion('5.3'); //static:: since PHP 5.3
61
62	1	return $metadata;
63		}
64		}
65

ovr / phpsa

Pull Request — master (#238)

FinalStaticUsage::pass() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like