AdminHelper::getEntityClassName() - Code Metrics - Inspection of "Remove deprecated code" - sonata-project/SonataAdminBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#6210)

by Jordi Sala

created 2020-08-03 13:41 UTC

AdminHelper::getEntityClassName() A

↳ Parent: Project

Complexity

Conditions	3
Paths	4

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	9.6333
c	0
b	0
f	0
cc	3
nc	4
nop	2

<?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\Admin;

use Doctrine\Common\Collections\Collection;
use Doctrine\ODM\MongoDB\PersistentCollection;
use Doctrine\ORM\PersistentCollection as DoctrinePersistentCollection;
use Sonata\AdminBundle\Exception\NoValueException;
use Sonata\AdminBundle\Manipulator\ObjectManipulator;
use Sonata\AdminBundle\Util\FormBuilderIterator;
use Sonata\AdminBundle\Util\FormViewIterator;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\Form\FormView;

/**
 * @final since sonata-project/admin-bundle 3.52
 *
 * @author Thomas Rabaix <[email protected]>
 */
class AdminHelper
{
    /**
     * @var string
     */
    private const FORM_FIELD_DELETE = '_delete';

    /**
     * @var Pool
     */
    protected $pool;

    public function __construct(Pool $pool)
    {
        $this->pool = $pool;
    }

    /**
     * @throws \RuntimeException
     */
    public function getChildFormBuilder(FormBuilderInterface $formBuilder, string $elementId): ?FormBuilderInterface
    {
        foreach (new FormBuilderIterator($formBuilder) as $name => $formBuilder) {
            if ($name === $elementId) {
                return $formBuilder;
            }
        }

        return null;
    }

    public function getChildFormView(FormView $formView, string $elementId): ?FormView
    {
        foreach (new \RecursiveIteratorIterator(new FormViewIterator($formView), \RecursiveIteratorIterator::SELF_FIRST) as $name => $formView) {
            if ($name === $elementId) {
                return $formView;
            }
        }

        return null;
    }

    /**
     * Note:
     *   This code is ugly, but there is no better way of doing it.
     *
     * @throws \RuntimeException
     * @throws \Exception
     */
    public function appendFormFieldElement(AdminInterface $admin, object $subject, string $elementId): array
    {
        // child rows marked as toDelete
        $toDelete = [];

        $formBuilder = $admin->getFormBuilder();

        // get the field element
        $childFormBuilder = $this->getChildFormBuilder($formBuilder, $elementId);

        if ($childFormBuilder) {
            $formData = $admin->getRequest()->get($formBuilder->getName(), []);
            if (\array_key_exists($childFormBuilder->getName(), $formData)) {
                $formData = $admin->getRequest()->get($formBuilder->getName(), []);
                $i = 0;
                foreach ($formData[$childFormBuilder->getName()] as $name => &$field) {
                    $toDelete[$i] = false;
                    if (\array_key_exists(self::FORM_FIELD_DELETE, $field)) {
                        $toDelete[$i] = true;
                        unset($field[self::FORM_FIELD_DELETE]);
                    }
                    ++$i;
                }
            }
            $admin->getRequest()->request->set($formBuilder->getName(), $formData);
        }

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

        //Child form not found (probably nested one)
        //if childFormBuilder was not found resulted in fatal error getName() method call on non object
        if (!$childFormBuilder) {
            $propertyAccessor = $this->pool->getPropertyAccessor();

            $path = $this->getElementAccessPath($elementId, $subject);

            $collection = $propertyAccessor->getValue($subject, $path);

            if ($collection instanceof DoctrinePersistentCollection || $collection instanceof PersistentCollection) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
                //since doctrine 2.4
                $modelClassName = $collection->getTypeClass()->getName();
            } elseif ($collection instanceof Collection) {
                $modelClassName = $this->getModelClassName($admin, explode('.', preg_replace('#\[\d*?\]#', '', $path)));
            } else {
                throw new \Exception('unknown collection class');
            }

            $collection->add(new $modelClassName());
            $propertyAccessor->setValue($subject, $path, $collection);

            $fieldDescription = null;
        } else {
            // retrieve the FieldDescription
            $fieldDescription = $admin->getFormFieldDescription($childFormBuilder->getName());

            try {
                $value = $fieldDescription->getValue($form->getData());
            } catch (NoValueException $e) {
                $value = null;
            }

            // retrieve the posted data
            $data = $admin->getRequest()->get($formBuilder->getName());

            if (!isset($data[$childFormBuilder->getName()])) {
                $data[$childFormBuilder->getName()] = [];
            }

            $objectCount = null === $value ? 0 : \count($value);
            $postCount = \count($data[$childFormBuilder->getName()]);

            $associationAdmin = $fieldDescription->getAssociationAdmin();

            // add new elements to the subject
            while ($objectCount < $postCount) {
                // append a new instance into the object
                ObjectManipulator::addInstance($form->getData(), $associationAdmin->getNewInstance(), $fieldDescription);
                ++$objectCount;
            }

            $newInstance = ObjectManipulator::addInstance($form->getData(), $associationAdmin->getNewInstance(), $fieldDescription);

            $associationAdmin->setSubject($newInstance);
        }

        $finalForm = $admin->getFormBuilder()->getForm();
        $finalForm->setData($subject);

        // bind the data
        $finalForm->setData($form->getData());

        // back up delete field
        if (\count($toDelete) > 0) {
            $i = 0;
            foreach ($finalForm->get($childFormBuilder->getName()) as $childField) {
                if ($childField->has(self::FORM_FIELD_DELETE)) {
                    $childField->get(self::FORM_FIELD_DELETE)->setData($toDelete[$i] ?? false);
                }
                ++$i;
            }
        }

        return [$fieldDescription, $finalForm];
    }

    /**
     * Get access path to element which works with PropertyAccessor.
     *
     * @param string $elementId expects string in format used in form id field.
     *                          (uniqueIdentifier_model_sub_model or uniqueIdentifier_model_1_sub_model etc.)
     * @param mixed  $model
     *
     * @throws \Exception
     */
    public function getElementAccessPath(string $elementId, $model): string
    {
        $propertyAccessor = $this->pool->getPropertyAccessor();

        $idWithoutIdentifier = preg_replace('/^[^_]*_/', '', $elementId);
        $initialPath = preg_replace('#(_(\d+)_)#', '[$2]_', $idWithoutIdentifier);

        $parts = explode('_', $initialPath);
        $totalPath = '';
        $currentPath = '';

        foreach ($parts as $part) {
            $currentPath .= empty($currentPath) ? $part : '_'.$part;
            $separator = empty($totalPath) ? '' : '.';

            if ($propertyAccessor->isReadable($model, $totalPath.$separator.$currentPath)) {
                $totalPath .= $separator.$currentPath;
                $currentPath = '';
            }
        }

        if (!empty($currentPath)) {
            throw new \Exception(sprintf(
                'Could not get element id from %s Failing part: %s',
                $elementId,
                $currentPath
            ));
        }

        return $totalPath;
    }

    /**
     * Recursively find the class name of the admin responsible for the element at the end of an association chain.
     */
    protected function getModelClassName(AdminInterface $admin, array $elements): string
    {
        $element = array_shift($elements);
        $associationAdmin = $admin->getFormFieldDescription($element)->getAssociationAdmin();
        if (0 === \count($elements)) {
            return $associationAdmin->getClass();
        }

        return $this->getModelClassName($associationAdmin, $elements);
    }
}


Pull Request — master (#6210)

AdminHelper::getEntityClassName() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

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\Admin;
15
16			use Doctrine\Common\Collections\Collection;
17			use Doctrine\ODM\MongoDB\PersistentCollection;
18			use Doctrine\ORM\PersistentCollection as DoctrinePersistentCollection;
19			use Sonata\AdminBundle\Exception\NoValueException;
20			use Sonata\AdminBundle\Manipulator\ObjectManipulator;
21			use Sonata\AdminBundle\Util\FormBuilderIterator;
22			use Sonata\AdminBundle\Util\FormViewIterator;
23			use Symfony\Component\Form\FormBuilderInterface;
24			use Symfony\Component\Form\FormView;
25
26			/**
27			* @final since sonata-project/admin-bundle 3.52
28			*
29			* @author Thomas Rabaix <[email protected]>
30			*/
31			class AdminHelper
32			{
33			/**
34			* @var string
35			*/
36			private const FORM_FIELD_DELETE = '_delete';
37
38			/**
39			* @var Pool
40			*/
41			protected $pool;
42
43			public function __construct(Pool $pool)
44			{
45			$this->pool = $pool;
46			}
47
48			/**
49			* @throws \RuntimeException
50			*/
51			public function getChildFormBuilder(FormBuilderInterface $formBuilder, string $elementId): ?FormBuilderInterface
52			{
53			foreach (new FormBuilderIterator($formBuilder) as $name => $formBuilder) {
54			if ($name === $elementId) {
55			return $formBuilder;
56			}
57			}
58
59			return null;
60			}
61
62			public function getChildFormView(FormView $formView, string $elementId): ?FormView
63			{
64			foreach (new \RecursiveIteratorIterator(new FormViewIterator($formView), \RecursiveIteratorIterator::SELF_FIRST) as $name => $formView) {
65			if ($name === $elementId) {
66			return $formView;
67			}
68			}
69
70			return null;
71			}
72
73			/**
74			* Note:
75			* This code is ugly, but there is no better way of doing it.
76			*
77			* @throws \RuntimeException
78			* @throws \Exception
79			*/
80			public function appendFormFieldElement(AdminInterface $admin, object $subject, string $elementId): array
81			{
82			// child rows marked as toDelete
83			$toDelete = [];
84
85			$formBuilder = $admin->getFormBuilder();
86
87			// get the field element
88			$childFormBuilder = $this->getChildFormBuilder($formBuilder, $elementId);
89
90			if ($childFormBuilder) {
91			$formData = $admin->getRequest()->get($formBuilder->getName(), []);
92			if (\array_key_exists($childFormBuilder->getName(), $formData)) {
93			$formData = $admin->getRequest()->get($formBuilder->getName(), []);
94			$i = 0;
95			foreach ($formData[$childFormBuilder->getName()] as $name => &$field) {
96			$toDelete[$i] = false;
97			if (\array_key_exists(self::FORM_FIELD_DELETE, $field)) {
98			$toDelete[$i] = true;
99			unset($field[self::FORM_FIELD_DELETE]);
100			}
101			++$i;
102			}
103			}
104			$admin->getRequest()->request->set($formBuilder->getName(), $formData);
105			}
106
107			$form = $formBuilder->getForm();
108			$form->setData($subject);
109			$form->handleRequest($admin->getRequest());
110
111			//Child form not found (probably nested one)
112			//if childFormBuilder was not found resulted in fatal error getName() method call on non object
113			if (!$childFormBuilder) {
114			$propertyAccessor = $this->pool->getPropertyAccessor();
115
116			$path = $this->getElementAccessPath($elementId, $subject);
117
118			$collection = $propertyAccessor->getValue($subject, $path);
119
120			if ($collection instanceof DoctrinePersistentCollection \|\| $collection instanceof PersistentCollection) {
			0 ignored issues – show Bug introduced 2017-12-10 19:17 UTC by Report Bug Copy Issue Report The class `Doctrine\ODM\MongoDB\PersistentCollection` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
121			//since doctrine 2.4
122			$modelClassName = $collection->getTypeClass()->getName();
123			} elseif ($collection instanceof Collection) {
124			$modelClassName = $this->getModelClassName($admin, explode('.', preg_replace('#\[\d*?\]#', '', $path)));
125			} else {
126			throw new \Exception('unknown collection class');
127			}
128
129			$collection->add(new $modelClassName());
130			$propertyAccessor->setValue($subject, $path, $collection);
131
132			$fieldDescription = null;
133			} else {
134			// retrieve the FieldDescription
135			$fieldDescription = $admin->getFormFieldDescription($childFormBuilder->getName());
136
137			try {
138			$value = $fieldDescription->getValue($form->getData());
139			} catch (NoValueException $e) {
140			$value = null;
141			}
142
143			// retrieve the posted data
144			$data = $admin->getRequest()->get($formBuilder->getName());
145
146			if (!isset($data[$childFormBuilder->getName()])) {
147			$data[$childFormBuilder->getName()] = [];
148			}
149
150			$objectCount = null === $value ? 0 : \count($value);
151			$postCount = \count($data[$childFormBuilder->getName()]);
152
153			$associationAdmin = $fieldDescription->getAssociationAdmin();
154
155			// add new elements to the subject
156			while ($objectCount < $postCount) {
157			// append a new instance into the object
158			ObjectManipulator::addInstance($form->getData(), $associationAdmin->getNewInstance(), $fieldDescription);
159			++$objectCount;
160			}
161
162			$newInstance = ObjectManipulator::addInstance($form->getData(), $associationAdmin->getNewInstance(), $fieldDescription);
163
164			$associationAdmin->setSubject($newInstance);
165			}
166
167			$finalForm = $admin->getFormBuilder()->getForm();
168			$finalForm->setData($subject);
169
170			// bind the data
171			$finalForm->setData($form->getData());
172
173			// back up delete field
174			if (\count($toDelete) > 0) {
175			$i = 0;
176			foreach ($finalForm->get($childFormBuilder->getName()) as $childField) {
177			if ($childField->has(self::FORM_FIELD_DELETE)) {
178			$childField->get(self::FORM_FIELD_DELETE)->setData($toDelete[$i] ?? false);
179			}
180			++$i;
181			}
182			}
183
184			return [$fieldDescription, $finalForm];
185			}
186
187			/**
188			* Get access path to element which works with PropertyAccessor.
189			*
190			* @param string $elementId expects string in format used in form id field.
191			* (uniqueIdentifier_model_sub_model or uniqueIdentifier_model_1_sub_model etc.)
192			* @param mixed $model
193			*
194			* @throws \Exception
195			*/
196			public function getElementAccessPath(string $elementId, $model): string
197			{
198			$propertyAccessor = $this->pool->getPropertyAccessor();
199
200			$idWithoutIdentifier = preg_replace('/^[^_]*_/', '', $elementId);
201			$initialPath = preg_replace('#(_(\d+)_)#', '[$2]_', $idWithoutIdentifier);
202
203			$parts = explode('_', $initialPath);
204			$totalPath = '';
205			$currentPath = '';
206
207			foreach ($parts as $part) {
208			$currentPath .= empty($currentPath) ? $part : '_'.$part;
209			$separator = empty($totalPath) ? '' : '.';
210
211			if ($propertyAccessor->isReadable($model, $totalPath.$separator.$currentPath)) {
212			$totalPath .= $separator.$currentPath;
213			$currentPath = '';
214			}
215			}
216
217			if (!empty($currentPath)) {
218			throw new \Exception(sprintf(
219			'Could not get element id from %s Failing part: %s',
220			$elementId,
221			$currentPath
222			));
223			}
224
225			return $totalPath;
226			}
227
228			/**
229			* Recursively find the class name of the admin responsible for the element at the end of an association chain.
230			*/
231			protected function getModelClassName(AdminInterface $admin, array $elements): string
232			{
233			$element = array_shift($elements);
234			$associationAdmin = $admin->getFormFieldDescription($element)->getAssociationAdmin();
235			if (0 === \count($elements)) {
236			return $associationAdmin->getClass();
237			}
238
239			return $this->getModelClassName($associationAdmin, $elements);
240			}
241			}
242

sonata-project / SonataAdminBundle

Pull Request — master (#6210)

AdminHelper::getEntityClassName() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like