Issues in PagePartTwigExtension.php - All Issues - Inspection of "Merge branch '5.6'" - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ae5e03...0447ee )

by Jeroen

created 2020-08-07 09:00 UTC

Twig/Extension/PagePartTwigExtension.php (1 issue)

Labels

Bug 1

Severity

Minor 1

Wesley Lancel 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace Kunstmaan\PagePartBundle\Twig\Extension;

use Doctrine\ORM\EntityManager;
use Kunstmaan\PagePartBundle\Entity\PagePartRef;
use Kunstmaan\PagePartBundle\Helper\HasPagePartsInterface;
use Kunstmaan\PagePartBundle\Helper\PagePartInterface;
use Kunstmaan\PagePartBundle\Repository\PagePartRefRepository;
use Twig\Environment;
use Twig\Extension\AbstractExtension;
use Twig\TwigFunction;

/**
 * PagePartTwigExtension
 *
 * @final since 5.4
 */
class PagePartTwigExtension extends AbstractExtension
{
    /**
     * @var EntityManager
     */
    protected $em;

    /**
     * @param EntityManager $em
     */
    public function __construct(EntityManager $em)
    {
        $this->em = $em;
    }

    /**
     * @return array
     */
    public function getFunctions()
    {
        return array(
            new TwigFunction('render_pageparts', array($this, 'renderPageParts'), array('needs_environment' => true, 'needs_context' => true, 'is_safe' => array('html'))),
            new TwigFunction('getpageparts', array('needs_environment' => true, $this, 'getPageParts')),
            new TwigFunction('has_page_parts', [$this, 'hasPageParts']),
        );
    }

    /**
     * @param Environment           $env
     * @param array                 $twigContext The twig context
     * @param HasPagePartsInterface $page        The page
     * @param string                $contextName The pagepart context
     * @param array                 $parameters  Some extra parameters
     *
     * @return string
     */
    public function renderPageParts(Environment $env, array $twigContext, HasPagePartsInterface $page, $contextName = 'main', array $parameters = array())
    {
        $template = $env->load('@KunstmaanPagePart/PagePartTwigExtension/widget.html.twig');
        /* @var $entityRepository PagePartRefRepository */
        $pageparts = $this->getPageParts($page, $contextName);
        $newTwigContext = array_merge($parameters, array(
            'pageparts' => $pageparts,
            'page' => $page,
        ));
        $newTwigContext = array_merge($newTwigContext, $twigContext);

        return $template->render($newTwigContext);
    }

    /**
     * @param HasPagePartsInterface $page    The page
     * @param string                $context The pagepart context
     *
     * @return PagePartInterface[]
     */
    public function getPageParts(HasPagePartsInterface $page, $context = 'main')
    {
        /** @var $entityRepository PagePartRefRepository */
        $entityRepository = $this->em->getRepository(PagePartRef::class);

        return $entityRepository->getPageParts($page, $context);
    }

    /**
     * @param HasPagePartsInterface $page
     * @param string                $context
     *
     * @return bool
     */
    public function hasPageParts(HasPagePartsInterface $page, $context = 'main')
    {
        return $this->em->getRepository(PagePartRef::class)->hasPageParts($page, $context);
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.
    }
}
    }
}


1		<?php
2
3		namespace Kunstmaan\PagePartBundle\Twig\Extension;
4
5		use Doctrine\ORM\EntityManager;
6		use Kunstmaan\PagePartBundle\Entity\PagePartRef;
7		use Kunstmaan\PagePartBundle\Helper\HasPagePartsInterface;
8		use Kunstmaan\PagePartBundle\Helper\PagePartInterface;
9		use Kunstmaan\PagePartBundle\Repository\PagePartRefRepository;
10		use Twig\Environment;
11		use Twig\Extension\AbstractExtension;
12		use Twig\TwigFunction;
13
14		/**
15		* PagePartTwigExtension
16		*
17		* @final since 5.4
18		*/
19		class PagePartTwigExtension extends AbstractExtension
20		{
21		/**
22		* @var EntityManager
23		*/
24		protected $em;
25
26		/**
27		* @param EntityManager $em
28		*/
29		public function __construct(EntityManager $em)
30		{
31		$this->em = $em;
32		}
33
34		/**
35		* @return array
36		*/
37		public function getFunctions()
38		{
39		return array(
40		new TwigFunction('render_pageparts', array($this, 'renderPageParts'), array('needs_environment' => true, 'needs_context' => true, 'is_safe' => array('html'))),
41		new TwigFunction('getpageparts', array('needs_environment' => true, $this, 'getPageParts')),
42		new TwigFunction('has_page_parts', [$this, 'hasPageParts']),
43		);
44		}
45
46		/**
47		* @param Environment $env
48		* @param array $twigContext The twig context
49		* @param HasPagePartsInterface $page The page
50		* @param string $contextName The pagepart context
51		* @param array $parameters Some extra parameters
52		*
53		* @return string
54		*/
55	View Code Duplication	public function renderPageParts(Environment $env, array $twigContext, HasPagePartsInterface $page, $contextName = 'main', array $parameters = array())
56		{
57		$template = $env->load('@KunstmaanPagePart/PagePartTwigExtension/widget.html.twig');
58		/* @var $entityRepository PagePartRefRepository */
59		$pageparts = $this->getPageParts($page, $contextName);
60		$newTwigContext = array_merge($parameters, array(
61		'pageparts' => $pageparts,
62		'page' => $page,
63		));
64		$newTwigContext = array_merge($newTwigContext, $twigContext);
65
66		return $template->render($newTwigContext);
67		}
68
69		/**
70		* @param HasPagePartsInterface $page The page
71		* @param string $context The pagepart context
72		*
73		* @return PagePartInterface[]
74		*/
75		public function getPageParts(HasPagePartsInterface $page, $context = 'main')
76		{
77		/** @var $entityRepository PagePartRefRepository */
78		$entityRepository = $this->em->getRepository(PagePartRef::class);
79
80		return $entityRepository->getPageParts($page, $context);
81		}
82
83		/**
84		* @param HasPagePartsInterface $page
85		* @param string $context
86		*
87		* @return bool
88		*/
89		public function hasPageParts(HasPagePartsInterface $page, $context = 'main')
90		{
91		return $this->em->getRepository(PagePartRef::class)->hasPageParts($page, $context);
		0 ignored issues – show Bug introduced 2020-06-11 21:21 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `Doctrine\Persistence\ObjectRepository` as the method `hasPageParts()` does only exist in the following implementations of said interface: `Kunstmaan\PagePartBundle...y\PagePartRefRepository`. 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...
92		}
93		}
94

Kunstmaan / KunstmaanBundlesCMS

Push — master ( ae5e03...0447ee )

Twig/Extension/PagePartTwigExtension.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Duplication Side-by-Side

Filter issues like