TranslationBlock::enterNode() - Code Metrics - Inspection of "Prepare 1.1 (#37)" - php-translation/extractor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a423a5...0fdb96 )

by Tobias

created 2017-03-11 16:00 UTC

TranslationBlock::enterNode() A

↳ Parent: TranslationBlock

Complexity

Conditions	3
Paths	3

Size

Total Lines	15
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	15
rs	9.4285
cc	3
eloc	9
nc	3
nop	2

<?php

/*
 * This file is part of the PHP Translation package.
 *
 * (c) PHP Translation team <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Translation\Extractor\Visitor\Twig;

use Translation\Extractor\Visitor\BaseVisitor;
use Twig_Environment;
use Twig_NodeInterface;

/**
 * @author Tobias Nyholm <[email protected]>
 *
 * @deprecated Use Twig1Visitor. Will be removed in 2.0
 */
final class TranslationBlock extends BaseVisitor implements \Twig_NodeVisitorInterface
{
    public function enterNode(Twig_NodeInterface $node, Twig_Environment $env)
    {
        if ($node instanceof TransNode) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $id = $node->getNode('body')->getAttribute('data');
            $domain = 'messages';
            if ($node->hasNode('domain')) {
                $domain = $node->getNode('domain')->getAttribute('value');
            }

            $source = new SourceLocation($id, $this->getAbsoluteFilePath(), $node->getLine(), ['domain' => $domain]);
            $this->collection->addLocation($source);
        }

        return $node;
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());
}
    }

    public function leaveNode(Twig_NodeInterface $node, Twig_Environment $env)
    {
        return $node;
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());
}
    }

    public function getPriority()
    {
        return 0;
    }
}


Push — master ( a423a5...0fdb96 )

TranslationBlock::enterNode() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1			<?php
2
3			/*
4			* This file is part of the PHP Translation package.
5			*
6			* (c) PHP Translation team <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Translation\Extractor\Visitor\Twig;
13
14			use Translation\Extractor\Visitor\BaseVisitor;
15			use Twig_Environment;
16			use Twig_NodeInterface;
17
18			/**
19			* @author Tobias Nyholm <[email protected]>
20			*
21			* @deprecated Use Twig1Visitor. Will be removed in 2.0
22			*/
23			final class TranslationBlock extends BaseVisitor implements \Twig_NodeVisitorInterface
24			{
25			public function enterNode(Twig_NodeInterface $node, Twig_Environment $env)
26			{
27			if ($node instanceof TransNode) {
			0 ignored issues – show Bug introduced 2017-03-11 16:03 UTC by Report Bug Copy Issue Report The class `Translation\Extractor\Visitor\Twig\TransNode` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
28			$id = $node->getNode('body')->getAttribute('data');
29			$domain = 'messages';
30			if ($node->hasNode('domain')) {
31			$domain = $node->getNode('domain')->getAttribute('value');
32			}
33
34			$source = new SourceLocation($id, $this->getAbsoluteFilePath(), $node->getLine(), ['domain' => $domain]);
35			$this->collection->addLocation($source);
36			}
37
38			return $node;
			0 ignored issues – show Bug Best Practice introduced 2017-03-11 16:03 UTC by Report Bug Copy Issue Report The return type of `return $node;` (`Twig_NodeInterface`) is incompatible with the return type declared by the interface `Twig_NodeVisitorInterface::enterNode` of type `Twig_Node`. 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...
39			}
40
41			public function leaveNode(Twig_NodeInterface $node, Twig_Environment $env)
42			{
43			return $node;
			0 ignored issues – show Bug Best Practice introduced 2017-01-07 09:55 UTC by Report Bug Copy Issue Report The return type of `return $node;` (`Twig_NodeInterface`) is incompatible with the return type declared by the interface `Twig_NodeVisitorInterface::leaveNode` of type `Twig_Node\|false`. 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...
44			}
45
46			public function getPriority()
47			{
48			return 0;
49			}
50			}
51

php-translation / extractor

Push — master ( a423a5...0fdb96 )

TranslationBlock::enterNode() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like