FormElementContext::checkAllowAddOption() - Code Metrics - Inspection of "Proper validation of allow_add and allow_delete op..." - fsi-open/admin-bundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — 2.1 (#259)

by Piotr

created 2017-02-13 23:04 UTC

FormElementContext::checkAllowAddOption() A

↳ Parent: FormElementContext

Complexity

Conditions	3
Paths	2

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * (c) FSi sp. z o.o. <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace FSi\Bundle\AdminBundle\Admin\CRUD\Context;

use FSi\Bundle\AdminBundle\Admin\Context\ContextAbstract;
use FSi\Bundle\AdminBundle\Admin\CRUD\FormElement;
use FSi\Bundle\AdminBundle\Admin\Element;
use FSi\Bundle\AdminBundle\Event\FormEvent;
use Symfony\Component\Form\FormInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

class FormElementContext extends ContextAbstract
{
    /**
     * @var FormElement
     */
    protected $element;

    /**
     * @var FormInterface
     */
    protected $form;

    /**
     * {@inheritdoc}
     */
    public function hasTemplateName()
    {
        return $this->element->hasOption('template_form');
    }

    /**
     * {@inheritdoc}
     */
    public function getTemplateName()
    {
        return $this->element->getOption('template_form');
    }

    /**
     * {@inheritdoc}
     */
    public function getData()
    {
        $data = array(
            'form' => $this->form->createView(),
            'element' => $this->element
        );

        if ($this->form->getData()) {
            $data['id'] = $this->element->getDataIndexer()->getIndex($this->form->getData());
        }

        return $data;
    }

    /**
     * {@inheritdoc}
     */
    public function setElement(Element $element)
    {
        $this->element = $element;
class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
    }

    /**
     * {@inheritdoc}
     */
    protected function createEvent(Request $request)
    {
        $this->form = $this->element->createForm($this->getObject($request));

        return new FormEvent($this->element, $request, $this->form);
/** @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 string
     */
    protected function getSupportedRoute()
    {
        return 'fsi_admin_form';
    }

    /**
     * {@inheritdoc}
     */
    protected function supportsElement(Element $element)
    {
        return $element instanceof FormElement;
    }

    /**
     * @param Request $request
     * @return object|null
     */
    private function getObject(Request $request)
    {
        $id = $request->get('id');
        if (empty($id)) {
            $this->checkAllowAddOption();
            return null;
        }

        $object = $this->element->getDataIndexer()->getData($id);
        if (!$object) {
            throw new NotFoundHttpException(sprintf('Can\'t find object with id %s', $id));
        }

        return $object;
    }

    /**
     * @throws NotFoundHttpException
     */
    private function checkAllowAddOption()
    {
        if ($this->element->hasOption('allow_add')
            && !$this->element->getOption('allow_add')
        ) {
            throw new NotFoundHttpException(sprintf(
                'Cannot add objects through element "%s", because it has option "allow_add" set to false',
                get_class($this->element)
            ));
        }
    }
}


1			<?php
2
3			/**
4			* (c) FSi sp. z o.o. <[email protected]>
5			*
6			* For the full copyright and license information, please view the LICENSE
7			* file that was distributed with this source code.
8			*/
9
10			namespace FSi\Bundle\AdminBundle\Admin\CRUD\Context;
11
12			use FSi\Bundle\AdminBundle\Admin\Context\ContextAbstract;
13			use FSi\Bundle\AdminBundle\Admin\CRUD\FormElement;
14			use FSi\Bundle\AdminBundle\Admin\Element;
15			use FSi\Bundle\AdminBundle\Event\FormEvent;
16			use Symfony\Component\Form\FormInterface;
17			use Symfony\Component\HttpFoundation\Request;
18			use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
19
20			class FormElementContext extends ContextAbstract
21			{
22			/**
23			* @var FormElement
24			*/
25			protected $element;
26
27			/**
28			* @var FormInterface
29			*/
30			protected $form;
31
32			/**
33			* {@inheritdoc}
34			*/
35			public function hasTemplateName()
36			{
37			return $this->element->hasOption('template_form');
38			}
39
40			/**
41			* {@inheritdoc}
42			*/
43			public function getTemplateName()
44			{
45			return $this->element->getOption('template_form');
46			}
47
48			/**
49			* {@inheritdoc}
50			*/
51			public function getData()
52			{
53			$data = array(
54			'form' => $this->form->createView(),
55			'element' => $this->element
56			);
57
58			if ($this->form->getData()) {
59			$data['id'] = $this->element->getDataIndexer()->getIndex($this->form->getData());
60			}
61
62			return $data;
63			}
64
65			/**
66			* {@inheritdoc}
67			*/
68			public function setElement(Element $element)
69			{
70			$this->element = $element;
			0 ignored issues – show Documentation Bug introduced 2017-01-17 11:03 UTC by Report Bug Copy Issue Report `$element` is of type `object<FSi\Bundle\AdminBundle\Admin\Element>`, but the property `$element` was declared to be of type `object<FSi\Bundle\AdminB...Admin\CRUD\FormElement>`. Are you sure that you always receive this specific sub-class here, or does it make sense to add an `instanceof` check? Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly. Either this assignment is in error or an instanceof check should be added for that assignment. class Alien {} class Dalek extends Alien {} class Plot { /** @var Dalek */ public $villain; } $alien = new Alien(); $plot = new Plot(); if ($alien instanceof Dalek) { $plot->villain = $alien; } Loading history...
71			}
72
73			/**
74			* {@inheritdoc}
75			*/
76			protected function createEvent(Request $request)
77			{
78			$this->form = $this->element->createForm($this->getObject($request));
79
80			return new FormEvent($this->element, $request, $this->form);
			0 ignored issues – show Bug introduced 2017-01-17 11:03 UTC by Report Bug Copy Issue Report It seems like `$this->form` can be `null`; however, `__construct()` 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...
81			}
82
83			/**
84			* @return string
85			*/
86			protected function getSupportedRoute()
87			{
88			return 'fsi_admin_form';
89			}
90
91			/**
92			* {@inheritdoc}
93			*/
94			protected function supportsElement(Element $element)
95			{
96			return $element instanceof FormElement;
97			}
98
99			/**
100			* @param Request $request
101			* @return object\|null
102			*/
103			private function getObject(Request $request)
104			{
105			$id = $request->get('id');
106			if (empty($id)) {
107			$this->checkAllowAddOption();
108			return null;
109			}
110
111			$object = $this->element->getDataIndexer()->getData($id);
112			if (!$object) {
113			throw new NotFoundHttpException(sprintf('Can\'t find object with id %s', $id));
114			}
115
116			return $object;
117			}
118
119			/**
120			* @throws NotFoundHttpException
121			*/
122			private function checkAllowAddOption()
123			{
124			if ($this->element->hasOption('allow_add')
125			&& !$this->element->getOption('allow_add')
126			) {
127			throw new NotFoundHttpException(sprintf(
128			'Cannot add objects through element "%s", because it has option "allow_add" set to false',
129			get_class($this->element)
130			));
131			}
132			}
133			}
134

fsi-open / admin-bundle

Pull Request — 2.1 (#259)

FormElementContext::checkAllowAddOption() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like