TwigFileExtractor::__construct() - Code Metrics - Inspection of "Patch bugfix" - php-translation/extractor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#14)

by Tobias

created 2016-12-05 18:30 UTC

TwigFileExtractor::__construct() A

↳ Parent: TwigFileExtractor

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	2
eloc	2
nc	2
nop	1
crap	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\FileExtractor;

use Symfony\Component\Finder\SplFileInfo;
use Translation\Extractor\Model\SourceCollection;
use Translation\Extractor\Visitor\Visitor;

/**
 * @author Tobias Nyholm <[email protected]>
 */
class TwigFileExtractor implements FileExtractor
{
    /**
     * @var Visitor[]|\Twig_NodeVisitorInterface[]
     */
    private $visitors = [];

    /**
     * @var \Twig_Environment
     */
    private $twig;

    /**
     * @param \Twig_Environment $twig
     */
    public function __construct(\Twig_Environment $twig = null)
    {
        $this->twig = $twig ?: new \Twig_Environment();
    }

    public function getSourceLocations(SplFileInfo $file, SourceCollection $collection)
    {
        foreach ($this->visitors as $v) {
            $v->init($collection, $file);
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.
}
        }

        $path = $file->getRelativePath();

        $tokens = $this->twig->parse($this->twig->tokenize($file->getContents(), $path));
        $traverser = new \Twig_NodeTraverser($this->twig, $this->visitors);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $traverser->traverse($tokens);
    }

    public function getType()
    {
        return 'twig';
    }

    /**
     * @param \Twig_NodeVisitorInterface $visitor
     */
    public function addVisitor(\Twig_NodeVisitorInterface $visitor)
    {
        $this->visitors[] = $visitor;
    }
}


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\FileExtractor;
13
14		use Symfony\Component\Finder\SplFileInfo;
15		use Translation\Extractor\Model\SourceCollection;
16		use Translation\Extractor\Visitor\Visitor;
17
18		/**
19		* @author Tobias Nyholm <[email protected]>
20		*/
21		class TwigFileExtractor implements FileExtractor
22		{
23		/**
24		* @var Visitor[]\|\Twig_NodeVisitorInterface[]
25		*/
26		private $visitors = [];
27
28		/**
29		* @var \Twig_Environment
30		*/
31		private $twig;
32
33		/**
34		* @param \Twig_Environment $twig
35		*/
36	4	public function __construct(\Twig_Environment $twig = null)
37		{
38	4	$this->twig = $twig ?: new \Twig_Environment();
39	4	}
40
41	4	public function getSourceLocations(SplFileInfo $file, SourceCollection $collection)
42		{
43	4	foreach ($this->visitors as $v) {
44	4	$v->init($collection, $file);
		0 ignored issues – show Bug introduced 2016-12-05 09:59 UTC by Report Bug Copy Issue Report The method `init` does only exist in `Translation\Extractor\Visitor\Visitor`, but not in `Twig_NodeVisitorInterface`. 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...
45	4	}
46
47	4	$path = $file->getRelativePath();
48
49	4	$tokens = $this->twig->parse($this->twig->tokenize($file->getContents(), $path));
50	4	$traverser = new \Twig_NodeTraverser($this->twig, $this->visitors);
		0 ignored issues – show Documentation introduced 2016-12-05 09:59 UTC by Report Bug Copy Issue Report `$this->visitors` is of type `array<integer,object<Tra..._NodeVisitorInterface>>`, but the function expects a `array<integer,object<Twig_NodeVisitorInterface>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
51	4	$traverser->traverse($tokens);
52	4	}
53
54	1	public function getType()
55		{
56	1	return 'twig';
57		}
58
59		/**
60		* @param \Twig_NodeVisitorInterface $visitor
61		*/
62	4	public function addVisitor(\Twig_NodeVisitorInterface $visitor)
63		{
64	4	$this->visitors[] = $visitor;
65	4	}
66		}
67

php-translation / extractor

Pull Request — master (#14)

TwigFileExtractor::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like