Extension::getFunctions() - Code Metrics - Inspection of "Added cache warmer, added some tests, codebase cle..." - RunOpenCode/query-resources-loader-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b95763...2cb7d7 )

by Nikola

created 2016-07-01 09:21 UTC

Extension::getFunctions() A

↳ Parent: Extension

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	8
rs	9.4285
cc	1
eloc	5
nc	1
nop	0

<?php
/*
 * This file is part of the QueryResourcesLoaderBundle, an RunOpenCode project.
 *
 * (c) 2016 RunOpenCode
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace RunOpenCode\Bundle\QueryResourcesLoader\Twig;

use Symfony\Bridge\Doctrine\RegistryInterface;

class Extension extends \Twig_Extension
{
    /**
     * @var RegistryInterface
     */
    private $doctrine;

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

    /**
     * {@inheritdoc}
     */
    public function getName()
    {
        return 'run_open_code_query_resources_loader';
    }

    /**
     * {@inheritdoc}
     */
    public function getFunctions()
    {
        return array(
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());
}
            new \Twig_Function('table_name', \Closure::bind(function($entity) {
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                return $this->getTableName($entity);
            }, $this))
        );
    }

    public function getFilters()
    {
        return array(
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());
}
            new \Twig_Filter('table_name', \Closure::bind(function($entity) {
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                return $this->getTableName($entity);
            }, $this))
        );
    }

    private function getTableName($entity)
    {
        if (is_object($entity)) {
            $entity = get_class($entity);
        }

        return $this->doctrine->getEntityManagerForClass($entity)->getClassMetadata($entity)->getTableName();
    }
}


1			<?php
2			/*
3			* This file is part of the QueryResourcesLoaderBundle, an RunOpenCode project.
4			*
5			* (c) 2016 RunOpenCode
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10			namespace RunOpenCode\Bundle\QueryResourcesLoader\Twig;
11
12			use Symfony\Bridge\Doctrine\RegistryInterface;
13
14			class Extension extends \Twig_Extension
15			{
16			/**
17			* @var RegistryInterface
18			*/
19			private $doctrine;
20
21			public function __construct(RegistryInterface $doctrine)
22			{
23			$this->doctrine = $doctrine;
24			}
25
26			/**
27			* {@inheritdoc}
28			*/
29			public function getName()
30			{
31			return 'run_open_code_query_resources_loader';
32			}
33
34			/**
35			* {@inheritdoc}
36			*/
37			public function getFunctions()
38			{
39			return array(
			0 ignored issues – show Bug Best Practice introduced 2016-07-01 09:51 UTC by Report Bug Copy Issue Report The return type of `return array(new \Twig_F...($entity); }, $this)));` (`Twig_Function[]`) is incompatible with the return type declared by the interface `Twig_ExtensionInterface::getFunctions` of type `Twig_SimpleFunction[]`. 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...
40			new \Twig_Function('table_name', \Closure::bind(function($entity) {
			0 ignored issues – show Documentation introduced 2016-07-01 09:51 UTC by Report Bug Copy Issue Report `'table_name'` is of type `string`, but the function expects a `array`. 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... Unused Code introduced 2016-07-01 09:51 UTC by Report Bug Copy Issue Report The call to `Twig_Function::__construct()` has too many arguments starting with `\Closure::bind(function ...ame($entity); }, $this)`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history... Deprecated Code introduced 2016-07-01 09:51 UTC by Report Bug Copy Issue Report The class `Twig_Function` has been deprecated with message: since 1.12 (to be removed in 2.0) This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
41			return $this->getTableName($entity);
42			}, $this))
43			);
44			}
45
46			public function getFilters()
47			{
48			return array(
			0 ignored issues – show Bug Best Practice introduced 2016-07-01 09:51 UTC by Report Bug Copy Issue Report The return type of `return array(new \Twig_F...($entity); }, $this)));` (`Twig_Filter[]`) is incompatible with the return type declared by the interface `Twig_ExtensionInterface::getFilters` of type `Twig_SimpleFilter[]`. 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...
49			new \Twig_Filter('table_name', \Closure::bind(function($entity) {
			0 ignored issues – show Documentation introduced 2016-07-01 09:51 UTC by Report Bug Copy Issue Report `'table_name'` is of type `string`, but the function expects a `array`. 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... Unused Code introduced 2016-07-01 09:51 UTC by Report Bug Copy Issue Report The call to `Twig_Filter::__construct()` has too many arguments starting with `\Closure::bind(function ...ame($entity); }, $this)`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history... Deprecated Code introduced 2016-07-01 09:51 UTC by Report Bug Copy Issue Report The class `Twig_Filter` has been deprecated with message: since 1.12 (to be removed in 2.0) This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
50			return $this->getTableName($entity);
51			}, $this))
52			);
53			}
54
55			private function getTableName($entity)
56			{
57			if (is_object($entity)) {
58			$entity = get_class($entity);
59			}
60
61			return $this->doctrine->getEntityManagerForClass($entity)->getClassMetadata($entity)->getTableName();
62			}
63			}
64

RunOpenCode / query-resources-loader-bundle

Push — master ( b95763...2cb7d7 )

Extension::getFunctions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like