TwigTemplate::getAttribute() - Code Metrics - Inspection of "Add missing Twig dependency and drop Twig < 2.4.0" - sonata-project/SonataCacheBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#158)

by Grégoire

created 2017-10-22 11:51 UTC

TwigTemplate::getAttribute() A

↳ Parent: TwigTemplate

Complexity

Conditions	3
Paths	2

Size

Total Lines	10
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	10
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	5
nc	2
nop	6

<?php

/*
 * 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\CacheBundle\Twig;

use Sonata\Cache\Invalidation\Recorder;
use Twig\Template;

abstract class TwigTemplate extends Template
{
    /**
     * @var \Sonata\CacheBundle\Invalidation\Recorder
     */
    protected static $recorder;

    /**
     * @static
     *
     * @param \Sonata\Cache\Invalidation\Recorder $recorder
     */
    public static function attachRecorder(Recorder $recorder)
    {
        self::$recorder = $recorder;

    }

    /**
     * @param mixed  $object
     * @param string $item
     * @param array  $arguments
     * @param string $type
     * @param bool   $isDefinedTest
     * @param bool   $ignoreStrictCheck
     *
     * @return mixed
     */
    protected function getAttribute($object, $item, array $arguments = [], $type = Template::ANY_CALL, $isDefinedTest = false, $ignoreStrictCheck = false)

    {
        $attribute = parent::getAttribute($object, $item, $arguments, $type, $isDefinedTest);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends 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.
    }
}

        if (self::$recorder && is_object($object)) {
            self::$recorder->add($object);
        }

        return $attribute;
    }
}


1			<?php
2
3			/*
4			* This file is part of the Sonata Project package.
5			*
6			* (c) Thomas Rabaix <[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 Sonata\CacheBundle\Twig;
13
14			use Sonata\Cache\Invalidation\Recorder;
15			use Twig\Template;
16
17			abstract class TwigTemplate extends Template
18			{
19			/**
20			* @var \Sonata\CacheBundle\Invalidation\Recorder
21			*/
22			protected static $recorder;
23
24			/**
25			* @static
26			*
27			* @param \Sonata\Cache\Invalidation\Recorder $recorder
28			*/
29			public static function attachRecorder(Recorder $recorder)
30			{
31			self::$recorder = $recorder;
			0 ignored issues – show Documentation Bug introduced 2017-10-20 20:46 UTC by Report Bug Copy Issue Report It seems like `$recorder` of type `object<Sonata\Cache\Invalidation\Recorder>` is incompatible with the declared type `object<Sonata\CacheBundle\Invalidation\Recorder>` of property `$recorder`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
32			}
33
34			/**
35			* @param mixed $object
36			* @param string $item
37			* @param array $arguments
38			* @param string $type
39			* @param bool $isDefinedTest
40			* @param bool $ignoreStrictCheck
41			*
42			* @return mixed
43			*/
44			protected function getAttribute($object, $item, array $arguments = [], $type = Template::ANY_CALL, $isDefinedTest = false, $ignoreStrictCheck = false)
			0 ignored issues – show Unused Code introduced 2017-10-22 09:23 UTC by Report Bug Copy Issue Report The parameter `$ignoreStrictCheck` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
45			{
46			$attribute = parent::getAttribute($object, $item, $arguments, $type, $isDefinedTest);
			0 ignored issues – show Bug introduced 2017-10-22 10:15 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Twig\Template` as the method `getAttribute()` does only exist in the following sub-classes of `Twig\Template`: `Sonata\CacheBundle\Twig\TwigTemplate`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends 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 sub-classes 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 parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
47
48			if (self::$recorder && is_object($object)) {
49			self::$recorder->add($object);
50			}
51
52			return $attribute;
53			}
54			}
55

sonata-project / SonataCacheBundle

Pull Request — master (#158)

TwigTemplate::getAttribute() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like