DocCommentReplacement::__construct() - Code Metrics - Stratadox/PhpGenerics - Measure and Improve Code Quality continuously with Scrutinizer

DocCommentReplacement::__construct() A
last analyzed 2020-03-04 23:14 UTC

↳ Parent: DocCommentReplacement

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	2
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	2

<?php declare(strict_types=1);

namespace Stratadox\PhpGenerics\Generator\Visitor;

use PhpParser\Comment\Doc;
use PhpParser\Node;
use PhpParser\Node\Stmt\ClassMethod;
use PhpParser\NodeVisitorAbstract;
use Stratadox\PhpGenerics\Generator\Type\TypeMap;
use function sprintf;
use function str_replace;

final class DocCommentReplacement extends NodeVisitorAbstract
{
    /** @var TypeMap */
    private $typeMap;
    /** @var string[] */
    private $annotations;

    public function __construct(TypeMap $typeMap, string ...$annotations)
    {
        $this->typeMap = $typeMap;
        $this->annotations = $annotations;
    }

    public function leaveNode(Node $node)
    {
        if (!$node instanceof ClassMethod) {
            return;
        }
        $doc = $node->getDocComment();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        if (!$doc) {

            return;
        }
        $search = [];
        $replace = [];
        foreach ($this->typeMap as $type => $argument) {
            foreach ($this->annotations as $annotation) {
                $search[] = sprintf($annotation, $type);
                $replace[] = sprintf($annotation, $argument);
            }
        }
        $node->setDocComment(new Doc(str_replace($search, $replace, $doc)));
    }
}


1			<?php declare(strict_types=1);
2
3			namespace Stratadox\PhpGenerics\Generator\Visitor;
4
5			use PhpParser\Comment\Doc;
6			use PhpParser\Node;
7			use PhpParser\Node\Stmt\ClassMethod;
8			use PhpParser\NodeVisitorAbstract;
9			use Stratadox\PhpGenerics\Generator\Type\TypeMap;
10			use function sprintf;
11			use function str_replace;
12
13			final class DocCommentReplacement extends NodeVisitorAbstract
14			{
15			/** @var TypeMap */
16			private $typeMap;
17			/** @var string[] */
18			private $annotations;
19
20			public function __construct(TypeMap $typeMap, string ...$annotations)
21			{
22			$this->typeMap = $typeMap;
23			$this->annotations = $annotations;
24			}
25
26			public function leaveNode(Node $node)
27			{
28			if (!$node instanceof ClassMethod) {
29			return;
30			}
31			$doc = $node->getDocComment();
			0 ignored issues – show Bug introduced 2020-03-04 22:57 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$doc` is correct as `$node->getDocComment()` targeting `PhpParser\NodeAbstract::getDocComment()` 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...
32			if (!$doc) {
			0 ignored issues – show introduced 2020-03-04 22:57 UTC by Report Bug Copy Issue Report `$doc` is of type `null`, thus it always evaluated to `false`. Loading history...
33			return;
34			}
35			$search = [];
36			$replace = [];
37			foreach ($this->typeMap as $type => $argument) {
38			foreach ($this->annotations as $annotation) {
39			$search[] = sprintf($annotation, $type);
40			$replace[] = sprintf($annotation, $argument);
41			}
42			}
43			$node->setDocComment(new Doc(str_replace($search, $replace, $doc)));
44			}
45			}
46

Stratadox / PhpGenerics

DocCommentReplacement::__construct() A last analyzed 2020-03-04 23:14 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

DocCommentReplacement::__construct() A
last analyzed 2020-03-04 23:14 UTC