SetObjectFieldValueAction::__construct() - Code Metrics - sonata-project/SonataAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

SetObjectFieldValueAction::__construct() A
last analyzed 2020-08-22 14:45 UTC

↳ Parent: SetObjectFieldValueAction

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	6
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	3

<?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\Pool;
use Sonata\AdminBundle\Templating\TemplateRegistry;
use Sonata\AdminBundle\Twig\Extension\SonataAdminExtension;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
use Symfony\Component\PropertyAccess\PropertyPath;
use Symfony\Component\Validator\Validator\ValidatorInterface;
use Twig\Environment;

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

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

    /**
     * @var ValidatorInterface
     */
    private $validator;

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

    /**
     * @throws NotFoundHttpException
     */
    public function __invoke(Request $request): JsonResponse
    {
        $field = $request->get('field');
        $code = $request->get('code');
        $objectId = $request->get('objectId');
        $value = $originalValue = $request->get('value');
        $context = $request->get('context');

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

        // alter should be done by using a post method
        if (!$request->isXmlHttpRequest()) {
            return new JsonResponse('Expected an XmlHttpRequest request header', Response::HTTP_METHOD_NOT_ALLOWED);
        }

        if (Request::METHOD_POST !== $request->getMethod()) {
            return new JsonResponse(sprintf(
                'Invalid request method given "%s", %s expected',
                $request->getMethod(),
                Request::METHOD_POST
            ), Response::HTTP_METHOD_NOT_ALLOWED);
        }

        $rootObject = $object = $admin->getObject($objectId);

        if (!$object) {
            return new JsonResponse('Object does not exist', Response::HTTP_NOT_FOUND);
        }

        // check user permission
        if (false === $admin->hasAccess('edit', $object)) {
            return new JsonResponse('Invalid permissions', Response::HTTP_FORBIDDEN);
        }

        if ('list' !== $context) {
            return new JsonResponse('Invalid context', Response::HTTP_BAD_REQUEST);
        }

        if (!$admin->hasListFieldDescription($field)) {
            return new JsonResponse('The field does not exist', Response::HTTP_BAD_REQUEST);
        }

        $fieldDescription = $admin->getListFieldDescription($field);

        if (!$fieldDescription->getOption('editable')) {
            return new JsonResponse('The field cannot be edited, editable option must be set to true', Response::HTTP_BAD_REQUEST);
        }

        $propertyPath = new PropertyPath($field);

        // If property path has more than 1 element, take the last object in order to validate it
        if ($propertyPath->getLength() > 1) {
            $object = $this->pool->getPropertyAccessor()->getValue($object, $propertyPath->getParent());
/** @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);
    }
}

            $elements = $propertyPath->getElements();
            $field = end($elements);
            $propertyPath = new PropertyPath($field);
        }

        // Handle date type has setter expect a DateTime object
        if ('' !== $value && TemplateRegistry::TYPE_DATE === $fieldDescription->getType()) {
            $inputTimezone = new \DateTimeZone(date_default_timezone_get());
            $outputTimezone = $fieldDescription->getOption('timezone');

            if ($outputTimezone && !$outputTimezone instanceof \DateTimeZone) {
                $outputTimezone = new \DateTimeZone($outputTimezone);
            }

            $value = new \DateTime($value, $outputTimezone ?: $inputTimezone);
            $value->setTimezone($inputTimezone);
        }

        // Handle boolean type transforming the value into a boolean
        if ('' !== $value && TemplateRegistry::TYPE_BOOLEAN === $fieldDescription->getType()) {
            $value = filter_var($value, FILTER_VALIDATE_BOOLEAN);
        }

        // Handle entity choice association type, transforming the value into entity
        if ('' !== $value
            && TemplateRegistry::TYPE_CHOICE === $fieldDescription->getType()
            && null !== $fieldDescription->getOption('class')
            && $fieldDescription->getOption('class') === $fieldDescription->getTargetModel()
        ) {
            $value = $admin->getModelManager()->find($fieldDescription->getOption('class'), $value);

            if (!$value) {
                return new JsonResponse(sprintf(
                    'Edit failed, object with id: %s not found in association: %s.',
                    $originalValue,
                    $field
                ), Response::HTTP_NOT_FOUND);
            }
        }

        $this->pool->getPropertyAccessor()->setValue($object, $propertyPath, '' !== $value ? $value : null);

        $violations = $this->validator->validate($object);

        if (\count($violations)) {
            $messages = [];

            foreach ($violations as $violation) {
                $messages[] = $violation->getMessage();
            }

            return new JsonResponse(implode("\n", $messages), Response::HTTP_BAD_REQUEST);
        }

        $admin->update($object);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

        // render the widget
        // todo : fix this, the twig environment variable is not set inside the extension ...
        $extension = $this->twig->getExtension(SonataAdminExtension::class);
        \assert($extension instanceof SonataAdminExtension);

        $content = $extension->renderListElement($this->twig, $rootObject, $fieldDescription);

        return new JsonResponse($content, Response::HTTP_OK);
    }
}


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\Pool;
17			use Sonata\AdminBundle\Templating\TemplateRegistry;
18			use Sonata\AdminBundle\Twig\Extension\SonataAdminExtension;
19			use Symfony\Component\HttpFoundation\JsonResponse;
20			use Symfony\Component\HttpFoundation\Request;
21			use Symfony\Component\HttpFoundation\Response;
22			use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
23			use Symfony\Component\PropertyAccess\PropertyPath;
24			use Symfony\Component\Validator\Validator\ValidatorInterface;
25			use Twig\Environment;
26
27			final class SetObjectFieldValueAction
28			{
29			/**
30			* @var Pool
31			*/
32			private $pool;
33
34			/**
35			* @var Environment
36			*/
37			private $twig;
38
39			/**
40			* @var ValidatorInterface
41			*/
42			private $validator;
43
44			public function __construct(Environment $twig, Pool $pool, ValidatorInterface $validator)
45			{
46			$this->pool = $pool;
47			$this->twig = $twig;
48			$this->validator = $validator;
49			}
50
51			/**
52			* @throws NotFoundHttpException
53			*/
54			public function __invoke(Request $request): JsonResponse
55			{
56			$field = $request->get('field');
57			$code = $request->get('code');
58			$objectId = $request->get('objectId');
59			$value = $originalValue = $request->get('value');
60			$context = $request->get('context');
61
62			$admin = $this->pool->getInstance($code);
63			$admin->setRequest($request);
64
65			// alter should be done by using a post method
66			if (!$request->isXmlHttpRequest()) {
67			return new JsonResponse('Expected an XmlHttpRequest request header', Response::HTTP_METHOD_NOT_ALLOWED);
68			}
69
70			if (Request::METHOD_POST !== $request->getMethod()) {
71			return new JsonResponse(sprintf(
72			'Invalid request method given "%s", %s expected',
73			$request->getMethod(),
74			Request::METHOD_POST
75			), Response::HTTP_METHOD_NOT_ALLOWED);
76			}
77
78			$rootObject = $object = $admin->getObject($objectId);
79
80			if (!$object) {
81			return new JsonResponse('Object does not exist', Response::HTTP_NOT_FOUND);
82			}
83
84			// check user permission
85			if (false === $admin->hasAccess('edit', $object)) {
86			return new JsonResponse('Invalid permissions', Response::HTTP_FORBIDDEN);
87			}
88
89			if ('list' !== $context) {
90			return new JsonResponse('Invalid context', Response::HTTP_BAD_REQUEST);
91			}
92
93			if (!$admin->hasListFieldDescription($field)) {
94			return new JsonResponse('The field does not exist', Response::HTTP_BAD_REQUEST);
95			}
96
97			$fieldDescription = $admin->getListFieldDescription($field);
98
99			if (!$fieldDescription->getOption('editable')) {
100			return new JsonResponse('The field cannot be edited, editable option must be set to true', Response::HTTP_BAD_REQUEST);
101			}
102
103			$propertyPath = new PropertyPath($field);
104
105			// If property path has more than 1 element, take the last object in order to validate it
106			if ($propertyPath->getLength() > 1) {
107			$object = $this->pool->getPropertyAccessor()->getValue($object, $propertyPath->getParent());
			0 ignored issues – show Bug introduced 2017-05-15 14:24 UTC by Report Bug Copy Issue Report It seems like `$propertyPath->getParent()` can be `null`; however, `getValue()` 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...
108
109			$elements = $propertyPath->getElements();
110			$field = end($elements);
111			$propertyPath = new PropertyPath($field);
112			}
113
114			// Handle date type has setter expect a DateTime object
115			if ('' !== $value && TemplateRegistry::TYPE_DATE === $fieldDescription->getType()) {
116			$inputTimezone = new \DateTimeZone(date_default_timezone_get());
117			$outputTimezone = $fieldDescription->getOption('timezone');
118
119			if ($outputTimezone && !$outputTimezone instanceof \DateTimeZone) {
120			$outputTimezone = new \DateTimeZone($outputTimezone);
121			}
122
123			$value = new \DateTime($value, $outputTimezone ?: $inputTimezone);
124			$value->setTimezone($inputTimezone);
125			}
126
127			// Handle boolean type transforming the value into a boolean
128			if ('' !== $value && TemplateRegistry::TYPE_BOOLEAN === $fieldDescription->getType()) {
129			$value = filter_var($value, FILTER_VALIDATE_BOOLEAN);
130			}
131
132			// Handle entity choice association type, transforming the value into entity
133			if ('' !== $value
134			&& TemplateRegistry::TYPE_CHOICE === $fieldDescription->getType()
135			&& null !== $fieldDescription->getOption('class')
136			&& $fieldDescription->getOption('class') === $fieldDescription->getTargetModel()
137			) {
138			$value = $admin->getModelManager()->find($fieldDescription->getOption('class'), $value);
139
140			if (!$value) {
141			return new JsonResponse(sprintf(
142			'Edit failed, object with id: %s not found in association: %s.',
143			$originalValue,
144			$field
145			), Response::HTTP_NOT_FOUND);
146			}
147			}
148
149			$this->pool->getPropertyAccessor()->setValue($object, $propertyPath, '' !== $value ? $value : null);
150
151			$violations = $this->validator->validate($object);
152
153			if (\count($violations)) {
154			$messages = [];
155
156			foreach ($violations as $violation) {
157			$messages[] = $violation->getMessage();
158			}
159
160			return new JsonResponse(implode("\n", $messages), Response::HTTP_BAD_REQUEST);
161			}
162
163			$admin->update($object);
			0 ignored issues – show Documentation introduced 2020-07-12 18:39 UTC by Report Bug Copy Issue Report `$object` is of type `object\|array`, but the function expects a `object<Sonata\AdminBundle\Admin\object>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
164
165			// render the widget
166			// todo : fix this, the twig environment variable is not set inside the extension ...
167			$extension = $this->twig->getExtension(SonataAdminExtension::class);
168			\assert($extension instanceof SonataAdminExtension);
169
170			$content = $extension->renderListElement($this->twig, $rootObject, $fieldDescription);
171
172			return new JsonResponse($content, Response::HTTP_OK);
173			}
174			}
175

sonata-project / SonataAdminBundle

SetObjectFieldValueAction::__construct() A last analyzed 2020-08-22 14:45 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

SetObjectFieldValueAction::__construct() A
last analyzed 2020-08-22 14:45 UTC