FormatterMediaExtension - Code Metrics - Inspection of "Bump test-related symfony components" - sonata-project/SonataMediaBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 5482a9...c97bf1 )

by Grégoire

created 2018-11-27 19:58 UTC

FormatterMediaExtension A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	131
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

Metric	Value
wmc	16
lcom	1
cbo	5
dl	0
loc	131
rs	10
c	0
b	0
f	0

16 Methods

Rating	Name	Size	Complexity
A	__construct()	4	1
A	getAllowedTags()	8	1
A	getAllowedMethods()	8	1
A	getTokenParsers()	8	1
A	getTwigExtension()	4	1
A	media()	4	1
A	thumbnail()	4	1
A	path()	4	1
A	getNodeVisitors()	4	1
A	getFilters()	4	1
A	getTests()	4	1
A	getFunctions()	4	1
A	getOperators()	4	1
A	getAllowedFilters()	4	1
A	getAllowedFunctions()	4	1
A	getAllowedProperties()	4	1

<?php

declare(strict_types=1);

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

namespace Sonata\MediaBundle\Twig\Extension;

use Sonata\MediaBundle\Model\MediaInterface;
use Sonata\MediaBundle\Twig\TokenParser\MediaTokenParser;
use Sonata\MediaBundle\Twig\TokenParser\PathTokenParser;
use Sonata\MediaBundle\Twig\TokenParser\ThumbnailTokenParser;
use Twig\Extension\AbstractExtension;
use Twig\Extension\ExtensionInterface;

class FormatterMediaExtension extends AbstractExtension implements ExtensionInterface
{
    /**
     * @var ExtensionInterface
     */
    protected $twigExtension;

    public function __construct(ExtensionInterface $twigExtension)
    {
        $this->twigExtension = $twigExtension;
    }

    /**
     * {@inheritdoc}
     */
    public function getAllowedTags(): array
    {
        return [
            'media',
            'path',
            'thumbnail',
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function getAllowedMethods(): array
    {
        return [
            MediaInterface::class => [
                'getproviderreference',
            ],
        ];
    }

    /**
     * {@inheritdoc}
     */
    public function getTokenParsers(): array
    {
        return [
            new MediaTokenParser(__CLASS__),
            new ThumbnailTokenParser(__CLASS__),
            new PathTokenParser(__CLASS__),
        ];
    }

    /**
     * @return ExtensionInterface
     */
    public function getTwigExtension(): ExtensionInterface
    {
        return $this->twigExtension;
    }

    /**
     * @param int    $media
     * @param string $format
     * @param array  $options
     *
     * @return string
     */
    public function media($media, $format, $options = [])
    {
        return $this->getTwigExtension()->media($media, $format, $options);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * @param int    $media
     * @param string $format
     * @param array  $options
     *
     * @return string
     */
    public function thumbnail($media, $format, $options = [])
    {
        return $this->getTwigExtension()->thumbnail($media, $format, $options);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    /**
     * @param int    $media
     * @param string $format
     *
     * @return string
     */
    public function path($media, $format)
    {
        return $this->getTwigExtension()->path($media, $format);
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
    }

    public function getNodeVisitors()
    {
        return $this->getTwigExtension()->getNodeVisitors();
    }

    public function getFilters()
    {
        return $this->getTwigExtension()->getFilters();
    }

    public function getTests()
    {
        return $this->getTwigExtension()->getTests();
    }

    public function getFunctions()
    {
        return $this->getTwigExtension()->getFunctions();
    }

    public function getOperators()
    {
        return $this->getTwigExtension()->getOperators();
    }

    public function getAllowedFilters()
    {
        return [];
    }

    public function getAllowedFunctions()
    {
        return [];
    }

    public function getAllowedProperties()
    {
        return [];
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the Sonata Project package.
7			*
8			* (c) Thomas Rabaix <[email protected]>
9			*
10			* For the full copyright and license information, please view the LICENSE
11			* file that was distributed with this source code.
12			*/
13
14			namespace Sonata\MediaBundle\Twig\Extension;
15
16			use Sonata\MediaBundle\Model\MediaInterface;
17			use Sonata\MediaBundle\Twig\TokenParser\MediaTokenParser;
18			use Sonata\MediaBundle\Twig\TokenParser\PathTokenParser;
19			use Sonata\MediaBundle\Twig\TokenParser\ThumbnailTokenParser;
20			use Twig\Extension\AbstractExtension;
21			use Twig\Extension\ExtensionInterface;
22
23			class FormatterMediaExtension extends AbstractExtension implements ExtensionInterface
24			{
25			/**
26			* @var ExtensionInterface
27			*/
28			protected $twigExtension;
29
30			public function __construct(ExtensionInterface $twigExtension)
31			{
32			$this->twigExtension = $twigExtension;
33			}
34
35			/**
36			* {@inheritdoc}
37			*/
38			public function getAllowedTags(): array
39			{
40			return [
41			'media',
42			'path',
43			'thumbnail',
44			];
45			}
46
47			/**
48			* {@inheritdoc}
49			*/
50			public function getAllowedMethods(): array
51			{
52			return [
53			MediaInterface::class => [
54			'getproviderreference',
55			],
56			];
57			}
58
59			/**
60			* {@inheritdoc}
61			*/
62			public function getTokenParsers(): array
63			{
64			return [
65			new MediaTokenParser(__CLASS__),
66			new ThumbnailTokenParser(__CLASS__),
67			new PathTokenParser(__CLASS__),
68			];
69			}
70
71			/**
72			* @return ExtensionInterface
73			*/
74			public function getTwigExtension(): ExtensionInterface
75			{
76			return $this->twigExtension;
77			}
78
79			/**
80			* @param int $media
81			* @param string $format
82			* @param array $options
83			*
84			* @return string
85			*/
86			public function media($media, $format, $options = [])
87			{
88			return $this->getTwigExtension()->media($media, $format, $options);
			0 ignored issues – show Bug introduced 2018-11-26 19:19 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Twig\Extension\ExtensionInterface` as the method `media()` does only exist in the following implementations of said interface: `Sonata\MediaBundle\Twig\...FormatterMediaExtension`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
89			}
90
91			/**
92			* @param int $media
93			* @param string $format
94			* @param array $options
95			*
96			* @return string
97			*/
98			public function thumbnail($media, $format, $options = [])
99			{
100			return $this->getTwigExtension()->thumbnail($media, $format, $options);
			0 ignored issues – show Bug introduced 2018-11-26 19:19 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Twig\Extension\ExtensionInterface` as the method `thumbnail()` does only exist in the following implementations of said interface: `Sonata\MediaBundle\Twig\...FormatterMediaExtension`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
101			}
102
103			/**
104			* @param int $media
105			* @param string $format
106			*
107			* @return string
108			*/
109			public function path($media, $format)
110			{
111			return $this->getTwigExtension()->path($media, $format);
			0 ignored issues – show Bug introduced 2018-11-26 19:19 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Twig\Extension\ExtensionInterface` as the method `path()` does only exist in the following implementations of said interface: `Sonata\MediaBundle\Twig\...FormatterMediaExtension`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
112			}
113
114			public function getNodeVisitors()
115			{
116			return $this->getTwigExtension()->getNodeVisitors();
117			}
118
119			public function getFilters()
120			{
121			return $this->getTwigExtension()->getFilters();
122			}
123
124			public function getTests()
125			{
126			return $this->getTwigExtension()->getTests();
127			}
128
129			public function getFunctions()
130			{
131			return $this->getTwigExtension()->getFunctions();
132			}
133
134			public function getOperators()
135			{
136			return $this->getTwigExtension()->getOperators();
137			}
138
139			public function getAllowedFilters()
140			{
141			return [];
142			}
143
144			public function getAllowedFunctions()
145			{
146			return [];
147			}
148
149			public function getAllowedProperties()
150			{
151			return [];
152			}
153			}
154

sonata-project / SonataMediaBundle

Push — master ( 5482a9...c97bf1 )

FormatterMediaExtension A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

16 Methods

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like