vendor/sonata-project/admin-bundle/src/Controller/HelperController.php line 37

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of the Sonata Project package.
  7.  *
  8.  * (c) Thomas Rabaix <thomas.rabaix@sonata-project.org>
  9.  *
  10.  * For the full copyright and license information, please view the LICENSE
  11.  * file that was distributed with this source code.
  12.  */
  14. namespace Sonata\AdminBundle\Controller;
  16. use Sonata\AdminBundle\Action\AppendFormFieldElementAction;
  17. use Sonata\AdminBundle\Action\GetShortObjectDescriptionAction;
  18. use Sonata\AdminBundle\Action\RetrieveAutocompleteItemsAction;
  19. use Sonata\AdminBundle\Action\RetrieveFormFieldElementAction;
  20. use Sonata\AdminBundle\Action\SetObjectFieldValueAction;
  21. use Sonata\AdminBundle\Admin\AdminHelper;
  22. use Sonata\AdminBundle\Admin\Pool;
  23. use Sonata\AdminBundle\Form\DataTransformerResolver;
  24. use Sonata\AdminBundle\Form\DataTransformerResolverInterface;
  25. use Symfony\Component\HttpFoundation\JsonResponse;
  26. use Symfony\Component\HttpFoundation\Request;
  27. use Symfony\Component\HttpFoundation\Response;
  28. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  29. use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  30. use Symfony\Component\Validator\Validator\ValidatorInterface;
  31. use Twig\Environment;
  33. @trigger_error(sprintf(
  34.     'The %s\HelperController class is deprecated since version 3.38.0 and will be removed in 4.0.'
  35.     .' Use actions inside Sonata\AdminBundle\Action instead.',
  36.     __NAMESPACE__
  37. ), \E_USER_DEPRECATED);
  39. /**
  40.  * NEXT_MAJOR: remove this class.
  41.  *
  42.  * @deprecated since sonata-project/admin-bundle 3.38.0, to be removed in 4.0. Use actions inside Sonata\AdminBundle\Action instead.
  43.  *
  44.  * @author Thomas Rabaix <thomas.rabaix@sonata-project.org>
  45.  */
  46. class HelperController
  47. {
  48.     /**
  49.      * @var Environment
  50.      */
  51.     protected $twig;
  53.     /**
  54.      * @var AdminHelper
  55.      */
  56.     protected $helper;
  58.     /**
  59.      * @var Pool
  60.      */
  61.     protected $pool;
  63.     /**
  64.      * @var ValidatorInterface
  65.      */
  66.     protected $validator;
  68.     /**
  69.      * @var DataTransformerResolver
  70.      */
  71.     private $resolver;
  73.     /**
  74.      * @param ValidatorInterface           $validator
  75.      * @param DataTransformerResolver|null $resolver
  76.      */
  77.     public function __construct(Environment $twig, Pool $pool, AdminHelper $helper, $validator, $resolver = null)
  78.     {
  79.         // NEXT_MAJOR: Move ValidatorInterface check to method signature
  80.         if (!($validator instanceof ValidatorInterface)) {
  81.             throw new \InvalidArgumentException(sprintf(
  82.                 'Argument 4 is an instance of %s, expecting an instance of %s',
  83.                 \get_class($validator),
  84.                 ValidatorInterface::class
  85.             ));
  86.         }
  88.         // NEXT_MAJOR: Move DataTransformerResolver check to method signature
  89.         if (!$resolver instanceof DataTransformerResolverInterface) {
  90.             @trigger_error(sprintf(
  91.                 'Passing other type than %s in argument 4 to %s() is deprecated since sonata-project/admin-bundle 3.76 and will throw %s exception in 4.0.',
  92.                 DataTransformerResolverInterface::class,
  93.                 __METHOD__,
  94.                 \TypeError::class
  95.             ), \E_USER_DEPRECATED);
  96.             $resolver = new DataTransformerResolver();
  97.         }
  99.         $this->twig = $twig;
  100.         $this->pool = $pool;
  101.         $this->helper = $helper;
  102.         $this->validator = $validator;
  103.         $this->resolver = $resolver;
  104.     }
  106.     /**
  107.      * @throws NotFoundHttpException
  108.      *
  109.      * @return Response
  110.      */
  111.     public function appendFormFieldElementAction(Request $request)
  112.     {
  113.         $action = new AppendFormFieldElementAction($this->twig, $this->pool, $this->helper);
  115.         return $action($request);
  116.     }
  118.     /**
  119.      * @throws NotFoundHttpException
  120.      *
  121.      * @return Response
  122.      */
  123.     public function retrieveFormFieldElementAction(Request $request)
  124.     {
  125.         $action = new RetrieveFormFieldElementAction($this->twig, $this->pool, $this->helper);
  127.         return $action($request);
  128.     }
  130.     /**
  131.      * @throws NotFoundHttpException|\RuntimeException
  132.      *
  133.      * @return Response
  134.      */
  135.     public function getShortObjectDescriptionAction(Request $request)
  136.     {
  137.         $action = new GetShortObjectDescriptionAction($this->twig, $this->pool);
  139.         return $action($request);
  140.     }
  142.     /**
  143.      * @return Response
  144.      */
  145.     public function setObjectFieldValueAction(Request $request)
  146.     {
  147.         $action = new SetObjectFieldValueAction($this->twig, $this->pool, $this->validator, $this->resolver);
  149.         return $action($request);
  150.     }
  152.     /**
  153.      * Retrieve list of items for autocomplete form field.
  154.      *
  155.      * @throws \RuntimeException
  156.      * @throws AccessDeniedException
  157.      *
  158.      * @return JsonResponse
  159.      */
  160.     public function retrieveAutocompleteItemsAction(Request $request)
  161.     {
  162.         $action = new RetrieveAutocompleteItemsAction($this->pool);
  164.         return $action($request);
  165.     }
  166. }