RetrieveFormFieldElementAction::getFormRenderer() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/3.x'" - sonata-project/SonataAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 3fd2dd...aba624 )

by Grégoire

created 2019-04-27 09:58 UTC

RetrieveFormFieldElementAction::getFormRenderer() A

↳ Parent: RetrieveFormFieldElementAction

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	20
rs	9.6
c	0
b	0
f	0
cc	3
nc	3
nop	0

<?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\AdminBundle\Action;

use Sonata\AdminBundle\Admin\AdminHelper;
use Sonata\AdminBundle\Admin\Pool;
use Symfony\Bridge\Twig\AppVariable;
use Symfony\Bridge\Twig\Command\DebugCommand;
use Symfony\Bridge\Twig\Extension\FormExtension;
use Symfony\Bridge\Twig\Form\TwigRenderer;
use Symfony\Component\Form\FormRenderer;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Twig\Environment;

final class RetrieveFormFieldElementAction
{
    /**
     * @var Pool
     */
    private $pool;

    /**
     * @var AdminHelper
     */
    private $helper;

    /**
     * @var Environment
     */
    private $twig;

    public function __construct(Environment $twig, Pool $pool, AdminHelper $helper)
    {
        $this->pool = $pool;
        $this->helper = $helper;
        $this->twig = $twig;
    }

    /**
     * @throws NotFoundHttpException
     */
    public function __invoke(Request $request): Response
    {
        $code = $request->get('code');
        $elementId = $request->get('elementId');
        $objectId = $request->get('objectId');
        $uniqid = $request->get('uniqid');

        $admin = $this->pool->getInstance($code);
        $admin->setRequest($request);

        if ($uniqid) {
            $admin->setUniqid($uniqid);
        }

        if ($objectId) {
            $subject = $admin->getObject($objectId);
            if (!$subject) {
                throw new NotFoundHttpException(sprintf(
                    'Unable to find the object id: %s, class: %s',
                    $objectId,
                    $admin->getClass()
                ));
            }
        } else {
            $subject = $admin->getNewInstance();
        }

        $admin->setSubject($subject);

        $formBuilder = $admin->getFormBuilder();

        $form = $formBuilder->getForm();
        $form->setData($subject);
        $form->handleRequest($request);

        $view = $this->helper->getChildFormView($form->createView(), $elementId);

        // render the widget
        $renderer = $this->getFormRenderer();
        $renderer->setTheme($view, $admin->getFormTheme());
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}

        return new Response($renderer->searchAndRenderBlock($view, 'widget'));
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
    }

    /**
     * @return FormRenderer|TwigRenderer
     */
    private function getFormRenderer()
    {
        // BC for Symfony < 3.2 where this runtime does not exists
        if (!method_exists(AppVariable::class, 'getToken')) {
            $extension = $this->twig->getExtension(FormExtension::class);
            $extension->initRuntime($this->twig);

            return $extension->renderer;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        }

        // BC for Symfony < 3.4 where runtime should be TwigRenderer
        if (!method_exists(DebugCommand::class, 'getLoaderPaths')) {
            $runtime = $this->twig->getRuntime(TwigRenderer::class);
            $runtime->setEnvironment($this->twig);

            return $runtime;
        }

        return $this->twig->getRuntime(FormRenderer::class);
    }
}


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\AdminBundle\Action;
15
16			use Sonata\AdminBundle\Admin\AdminHelper;
17			use Sonata\AdminBundle\Admin\Pool;
18			use Symfony\Bridge\Twig\AppVariable;
19			use Symfony\Bridge\Twig\Command\DebugCommand;
20			use Symfony\Bridge\Twig\Extension\FormExtension;
21			use Symfony\Bridge\Twig\Form\TwigRenderer;
22			use Symfony\Component\Form\FormRenderer;
23			use Symfony\Component\HttpFoundation\Request;
24			use Symfony\Component\HttpFoundation\Response;
25			use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
26			use Twig\Environment;
27
28			final class RetrieveFormFieldElementAction
29			{
30			/**
31			* @var Pool
32			*/
33			private $pool;
34
35			/**
36			* @var AdminHelper
37			*/
38			private $helper;
39
40			/**
41			* @var Environment
42			*/
43			private $twig;
44
45			public function __construct(Environment $twig, Pool $pool, AdminHelper $helper)
46			{
47			$this->pool = $pool;
48			$this->helper = $helper;
49			$this->twig = $twig;
50			}
51
52			/**
53			* @throws NotFoundHttpException
54			*/
55			public function __invoke(Request $request): Response
56			{
57			$code = $request->get('code');
58			$elementId = $request->get('elementId');
59			$objectId = $request->get('objectId');
60			$uniqid = $request->get('uniqid');
61
62			$admin = $this->pool->getInstance($code);
63			$admin->setRequest($request);
64
65			if ($uniqid) {
66			$admin->setUniqid($uniqid);
67			}
68
69			if ($objectId) {
70			$subject = $admin->getObject($objectId);
71			if (!$subject) {
72			throw new NotFoundHttpException(sprintf(
73			'Unable to find the object id: %s, class: %s',
74			$objectId,
75			$admin->getClass()
76			));
77			}
78			} else {
79			$subject = $admin->getNewInstance();
80			}
81
82			$admin->setSubject($subject);
83
84			$formBuilder = $admin->getFormBuilder();
85
86			$form = $formBuilder->getForm();
87			$form->setData($subject);
88			$form->handleRequest($request);
89
90			$view = $this->helper->getChildFormView($form->createView(), $elementId);
91
92			// render the widget
93			$renderer = $this->getFormRenderer();
94			$renderer->setTheme($view, $admin->getFormTheme());
			0 ignored issues – show Bug introduced 2017-11-15 22:40 UTC by Report Bug Copy Issue Report It seems like `$view` defined by `$this->helper->getChildF...eateView(), $elementId)` on line `90` can be `null`; however, `Symfony\Component\Form\FormRenderer::setTheme()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
95
96			return new Response($renderer->searchAndRenderBlock($view, 'widget'));
			0 ignored issues – show Bug introduced 2017-11-15 22:40 UTC by Report Bug Copy Issue Report It seems like `$view` defined by `$this->helper->getChildF...eateView(), $elementId)` on line `90` can be `null`; however, `Symfony\Component\Form\F...:searchAndRenderBlock()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
97			}
98
99			/**
100			* @return FormRenderer\|TwigRenderer
101			*/
102			private function getFormRenderer()
103			{
104			// BC for Symfony < 3.2 where this runtime does not exists
105			if (!method_exists(AppVariable::class, 'getToken')) {
106			$extension = $this->twig->getExtension(FormExtension::class);
107			$extension->initRuntime($this->twig);
108
109			return $extension->renderer;
			0 ignored issues – show Bug introduced 2019-03-23 23:05 UTC by Report Bug Copy Issue Report Accessing `renderer` on the interface `Twig\Extension\ExtensionInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
110			}
111
112			// BC for Symfony < 3.4 where runtime should be TwigRenderer
113			if (!method_exists(DebugCommand::class, 'getLoaderPaths')) {
114			$runtime = $this->twig->getRuntime(TwigRenderer::class);
115			$runtime->setEnvironment($this->twig);
116
117			return $runtime;
118			}
119
120			return $this->twig->getRuntime(FormRenderer::class);
121			}
122			}
123

sonata-project / SonataAdminBundle

Push — master ( 3fd2dd...aba624 )

RetrieveFormFieldElementAction::getFormRenderer() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like