Completed
Push — master ( 6d6774...64f3ed )
by Jeroen
11:23 queued 05:13
created

Twig/Extension/PagePartTwigExtension.php (1 issue)

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

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)
0 ignored issues
show
You have injected the EntityManager via parameter $em. This is generally not recommended as it might get closed and become unusable. Instead, it is recommended to inject the ManagerRegistry and retrieve the EntityManager via getManager() each time you need it.

The EntityManager might become unusable for example if a transaction is rolled back and it gets closed. Let’s assume that somewhere in your application, or in a third-party library, there is code such as the following:

function someFunction(ManagerRegistry $registry) {
    $em = $registry->getManager();
    $em->getConnection()->beginTransaction();
    try {
        // Do something.
        $em->getConnection()->commit();
    } catch (\Exception $ex) {
        $em->getConnection()->rollback();
        $em->close();

        throw $ex;
    }
}

If that code throws an exception and the EntityManager is closed. Any other code which depends on the same instance of the EntityManager during this request will fail.

On the other hand, if you instead inject the ManagerRegistry, the getManager() method guarantees that you will always get a usable manager instance.

Loading history...
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);
92
    }
93
}
94