AzineMailgunTwigExtension::getGlobals() - Code Metrics - Inspection of "Implemented Mailgun-Cockpit with a set of useful l..." - azine/AzineMailgunWebhooksBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6)

unknown

created 2017-07-14 13:56 UTC

AzineMailgunTwigExtension::getGlobals() A

↳ Parent: AzineMailgunTwigExtension

Complexity

Conditions	3
Paths	4

Size

Total Lines	19
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	13
nc	4
nop	0

<?php
namespace Azine\MailgunWebhooksBundle\Services;

use Azine\MailgunWebhooksBundle\DependencyInjection\AzineMailgunWebhooksExtension;
use Azine\MailgunWebhooksBundle\Entity\Repositories\MailgunEventRepository;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Class AzineMailgunTwigExtension
 * Provides some filters and global variables
 * @package Azine\MailgunWebhooksBundle\Services
 */
class AzineMailgunTwigExtension extends \Twig_Extension
{
    private $container;
    
    public function __construct(ContainerInterface $container)
    {
        $this->container = $container;
    }

    /**
     * {@inheritdoc}
     */
    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());
}
            'printArray' => new  \Twig_SimpleFilter('printArray', array($this, 'printArray'), array('is_safe' => array('html'))),
        );
    }

    /**
     * {@inheritdoc}
     */
    public function getGlobals()
    {
        if ($this->container->hasParameter(AzineMailgunWebhooksExtension::PREFIX . '_' . AzineMailgunWebhooksExtension::EMAIL_DOMAIN)) {
            $emailDomain = $this->container->getParameter(AzineMailgunWebhooksExtension::PREFIX . '_' . AzineMailgunWebhooksExtension::EMAIL_DOMAIN);
        } else {
            $emailDomain = '';
        }
        /** @var MailgunEventRepository $repository */
        $repository = $this->container->get('doctrine')->getManager()->getRepository('AzineMailgunWebhooksBundle:MailgunEvent');
        if (is_null($repository->getLastKnownSenderIp())) {
            $lastKnownIp = '';
        } else {
            $lastKnownIp = $repository->getLastKnownSenderIp();
        }
        return array(
            'emailDomain' => $emailDomain,
            'lastKnownIp' => $lastKnownIp
        );
    }

    /**
     *
     * @param  array $var
     * @return mixed
     */
    public static function printArray(array $var)
    {
        return var_dump($var);
    }

    /**
     * Returns the name of the extension.
     *
     * @return string The extension name
     */
    public function getName()
    {
        return 'azine_mailgun_webhooks_bundle_twig_extension';
    }
}


1			<?php
2			namespace Azine\MailgunWebhooksBundle\Services;
3
4			use Azine\MailgunWebhooksBundle\DependencyInjection\AzineMailgunWebhooksExtension;
5			use Azine\MailgunWebhooksBundle\Entity\Repositories\MailgunEventRepository;
6			use Symfony\Component\DependencyInjection\ContainerInterface;
7
8			/**
9			* Class AzineMailgunTwigExtension
10			* Provides some filters and global variables
11			* @package Azine\MailgunWebhooksBundle\Services
12			*/
13			class AzineMailgunTwigExtension extends \Twig_Extension
14			{
15			private $container;
16
17			public function __construct(ContainerInterface $container)
18			{
19			$this->container = $container;
20			}
21
22			/**
23			* {@inheritdoc}
24			*/
25			public function getFilters()
26			{
27			return array(
			0 ignored issues – show Bug Best Practice introduced 2017-05-02 14:23 UTC by Report Bug Copy Issue Report The return type of `return array('printArray...e' => array('html'))));` (`array<string,Twig_SimpleFilter>`) is incompatible with the return type declared by the interface `Twig_ExtensionInterface::getFilters` of type `Twig_Filter[]`. 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...
28			'printArray' => new \Twig_SimpleFilter('printArray', array($this, 'printArray'), array('is_safe' => array('html'))),
29			);
30			}
31
32			/**
33			* {@inheritdoc}
34			*/
35			public function getGlobals()
36			{
37			if ($this->container->hasParameter(AzineMailgunWebhooksExtension::PREFIX . '_' . AzineMailgunWebhooksExtension::EMAIL_DOMAIN)) {
38			$emailDomain = $this->container->getParameter(AzineMailgunWebhooksExtension::PREFIX . '_' . AzineMailgunWebhooksExtension::EMAIL_DOMAIN);
39			} else {
40			$emailDomain = '';
41			}
42			/** @var MailgunEventRepository $repository */
43			$repository = $this->container->get('doctrine')->getManager()->getRepository('AzineMailgunWebhooksBundle:MailgunEvent');
44			if (is_null($repository->getLastKnownSenderIp())) {
45			$lastKnownIp = '';
46			} else {
47			$lastKnownIp = $repository->getLastKnownSenderIp();
48			}
49			return array(
50			'emailDomain' => $emailDomain,
51			'lastKnownIp' => $lastKnownIp
52			);
53			}
54
55			/**
56			*
57			* @param array $var
58			* @return mixed
59			*/
60			public static function printArray(array $var)
61			{
62			return var_dump($var);
63			}
64
65			/**
66			* Returns the name of the extension.
67			*
68			* @return string The extension name
69			*/
70			public function getName()
71			{
72			return 'azine_mailgun_webhooks_bundle_twig_extension';
73			}
74			}
75

azine / AzineMailgunWebhooksBundle

Pull Request — master (#6)

AzineMailgunTwigExtension::getGlobals() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like