vendor/sylius/resource-bundle/src/Bundle/Controller/ControllerTrait.php line 236

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Sylius\Bundle\ResourceBundle\Controller;
  14. use Doctrine\Persistence\ManagerRegistry;
  15. use Psr\Container\ContainerInterface;
  16. use Psr\Link\LinkInterface;
  17. use Symfony\Component\Form\Extension\Core\Type\FormType;
  18. use Symfony\Component\Form\FormBuilderInterface;
  19. use Symfony\Component\Form\FormInterface;
  20. use Symfony\Component\HttpFoundation\BinaryFileResponse;
  21. use Symfony\Component\HttpFoundation\Exception\SessionNotFoundException;
  22. use Symfony\Component\HttpFoundation\JsonResponse;
  23. use Symfony\Component\HttpFoundation\RedirectResponse;
  24. use Symfony\Component\HttpFoundation\Request;
  25. use Symfony\Component\HttpFoundation\Response;
  26. use Symfony\Component\HttpFoundation\ResponseHeaderBag;
  27. use Symfony\Component\HttpFoundation\Session\FlashBagAwareSessionInterface;
  28. use Symfony\Component\HttpFoundation\StreamedResponse;
  29. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  30. use Symfony\Component\HttpKernel\HttpKernelInterface;
  31. use Symfony\Component\Messenger\Envelope;
  32. use Symfony\Component\Messenger\Stamp\StampInterface;
  33. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  34. use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  35. use Symfony\Component\Security\Core\User\UserInterface;
  36. use Symfony\Component\Security\Csrf\CsrfToken;
  37. use Symfony\Component\WebLink\EventListener\AddLinkHeaderListener;
  38. use Symfony\Component\WebLink\GenericLinkProvider;
  40. /**
  41.  * Common features needed in controllers.
  42.  *
  43.  * @author Fabien Potencier <fabien@symfony.com>
  44.  *
  45.  * @internal
  46.  *
  47.  * @property ContainerInterface $container
  48.  */
  49. trait ControllerTrait
  50. {
  51.     /**
  52.      * Returns true if the service id is defined.
  53.      *
  54.      * @final
  55.      */
  56.     protected function has(string $id): bool
  57.     {
  58.         return $this->container->has($id);
  59.     }
  61.     /**
  62.      * Gets a container service by its id.
  63.      *
  64.      * @return object The service
  65.      *
  66.      * @final
  67.      */
  68.     protected function get(string $id)
  69.     {
  70.         return $this->container->get($id);
  71.     }
  73.     /**
  74.      * Generates a URL from the given parameters.
  75.      *
  76.      * @see UrlGeneratorInterface
  77.      *
  78.      * @final
  79.      */
  80.     protected function generateUrl(string $route, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string
  81.     {
  82.         return $this->container->get('router')->generate($route, $parameters, $referenceType);
  83.     }
  85.     /**
  86.      * Forwards the request to another controller.
  87.      *
  88.      * @param string $controller The controller name (a string like Bundle\BlogBundle\Controller\PostController::indexAction)
  89.      *
  90.      * @final
  91.      */
  92.     protected function forward(string $controller, array $path = [], array $query = []): Response
  93.     {
  94.         $request = $this->container->get('request_stack')->getCurrentRequest();
  95.         $path['_controller'] = $controller;
  96.         $subRequest = $request->duplicate($query, null, $path);
  98.         return $this->container->get('http_kernel')->handle($subRequest, HttpKernelInterface::SUB_REQUEST);
  99.     }
  101.     /**
  102.      * Returns a RedirectResponse to the given URL.
  103.      *
  104.      * @final
  105.      */
  106.     protected function redirect(string $url, int $status = 302): RedirectResponse
  107.     {
  108.         return new RedirectResponse($url, $status);
  109.     }
  111.     /**
  112.      * Returns a RedirectResponse to the given route with the given parameters.
  113.      *
  114.      * @final
  115.      */
  116.     protected function redirectToRoute(string $route, array $parameters = [], int $status = 302): RedirectResponse
  117.     {
  118.         return $this->redirect($this->generateUrl($route, $parameters), $status);
  119.     }
  121.     /**
  122.      * Returns a JsonResponse that uses the serializer component if enabled, or json_encode.
  123.      *
  124.      * @final
  125.      */
  126.     protected function json($data, int $status = 200, array $headers = [], array $context = []): JsonResponse
  127.     {
  128.         if ($this->container->has('serializer')) {
  129.             $json = $this->container->get('serializer')->serialize($data, 'json', array_merge([
  130.                 'json_encode_options' => JsonResponse::DEFAULT_ENCODING_OPTIONS,
  131.             ], $context));
  133.             return new JsonResponse($json, $status, $headers, true);
  134.         }
  136.         return new JsonResponse($data, $status, $headers);
  137.     }
  139.     /**
  140.      * Returns a BinaryFileResponse object with original or customized file name and disposition header.
  141.      *
  142.      * @param \SplFileInfo|string $file File object or path to file to be sent as response
  143.      *
  144.      * @final
  145.      */
  146.     protected function file($file, string $fileName = null, string $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT): BinaryFileResponse
  147.     {
  148.         $response = new BinaryFileResponse($file);
  149.         $response->setContentDisposition($disposition, null === $fileName ? $response->getFile()->getFilename() : $fileName);
  151.         return $response;
  152.     }
  154.     /**
  155.      * Adds a flash message to the current session for type.
  156.      *
  157.      * @throws \LogicException
  158.      *
  159.      * @final
  160.      */
  161.     protected function addFlash(string $type, $message)
  162.     {
  163.         try {
  164.             $session = $this->container->get('request_stack')->getSession();
  165.         } catch (SessionNotFoundException $e) {
  166.             throw new \LogicException('You cannot use the addFlash method if sessions are disabled. Enable them in "config/packages/framework.yaml".', 0, $e);
  167.         }
  169.         if (!$session instanceof FlashBagAwareSessionInterface) {
  170.             trigger_deprecation('symfony/framework-bundle', '6.2', 'Calling "addFlash()" method when the session does not implement %s is deprecated.', FlashBagAwareSessionInterface::class);
  171.         }
  173.         $session->getFlashBag()->add($type, $message);
  174.     }
  176.     /**
  177.      * Checks if the attributes are granted against the current authentication token and optionally supplied subject.
  178.      *
  179.      * @throws \LogicException
  180.      *
  181.      * @final
  182.      */
  183.     protected function isGranted($attributes, $subject = null): bool
  184.     {
  185.         if (!$this->container->has('security.authorization_checker')) {
  186.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  187.         }
  189.         return $this->container->get('security.authorization_checker')->isGranted($attributes, $subject);
  190.     }
  192.     /**
  193.      * Throws an exception unless the attributes are granted against the current authentication token and optionally
  194.      * supplied subject.
  195.      *
  196.      * @throws AccessDeniedException
  197.      *
  198.      * @final
  199.      */
  200.     protected function denyAccessUnlessGranted($attributes, $subject = null, string $message = 'Access Denied.')
  201.     {
  202.         if (!$this->isGranted($attributes, $subject)) {
  203.             $exception = $this->createAccessDeniedException($message);
  204.             $exception->setAttributes($attributes);
  205.             $exception->setSubject($subject);
  207.             throw $exception;
  208.         }
  209.     }
  211.     /**
  212.      * Returns a rendered view.
  213.      *
  214.      * @final
  215.      */
  216.     protected function renderView(string $view, array $parameters = []): string
  217.     {
  218.         if ($this->container->has('templating')) {
  219.             @trigger_error('Using the "templating" service is deprecated since Symfony 4.3 and will be removed in 5.0; use Twig instead.', \E_USER_DEPRECATED);
  221.             return $this->container->get('templating')->render($view, $parameters);
  222.         }
  224.         if (!$this->container->has('twig')) {
  225.             throw new \LogicException('You can not use the "renderView" method if the Templating Component or the Twig Bundle are not available. Try running "composer require symfony/twig-bundle".');
  226.         }
  228.         return $this->container->get('twig')->render($view, $parameters);
  229.     }
  231.     /**
  232.      * Renders a view.
  233.      *
  234.      * @final
  235.      */
  236.     protected function render(
  237.         string $view,
  238.         array $parameters = [],
  239.         Response $response = null,
  240.         ?int $responseCode = null
  241.     ): Response {
  242.         if ($this->container->has('templating')) {
  243.             @trigger_error('Using the "templating" service is deprecated since Symfony 4.3 and will be removed in 5.0; use Twig instead.', \E_USER_DEPRECATED);
  245.             $content = $this->container->get('templating')->render($view, $parameters);
  246.         } elseif ($this->container->has('twig')) {
  247.             $content = $this->container->get('twig')->render($view, $parameters);
  248.         } else {
  249.             throw new \LogicException('You can not use the "render" method if the Templating Component or the Twig Bundle are not available. Try running "composer require symfony/twig-bundle".');
  250.         }
  252.         if (null === $response) {
  253.             $response = new Response();
  254.         }
  256.         $response->setContent($content);
  257.         if ($responseCode !== null) {
  258.             $response->setStatusCode($responseCode);
  259.         }
  261.         return $response;
  262.     }
  264.     /**
  265.      * Streams a view.
  266.      *
  267.      * @final
  268.      */
  269.     protected function stream(string $view, array $parameters = [], StreamedResponse $response = null): StreamedResponse
  270.     {
  271.         if ($this->container->has('templating')) {
  272.             @trigger_error('Using the "templating" service is deprecated since Symfony 4.3 and will be removed in 5.0; use Twig instead.', \E_USER_DEPRECATED);
  274.             $templating = $this->container->get('templating');
  276.             $callback = function () use ($templating, $view, $parameters) {
  277.                 $templating->stream($view, $parameters);
  278.             };
  279.         } elseif ($this->container->has('twig')) {
  280.             $twig = $this->container->get('twig');
  282.             $callback = function () use ($twig, $view, $parameters) {
  283.                 $twig->display($view, $parameters);
  284.             };
  285.         } else {
  286.             throw new \LogicException('You can not use the "stream" method if the Templating Component or the Twig Bundle are not available. Try running "composer require symfony/twig-bundle".');
  287.         }
  289.         if (null === $response) {
  290.             return new StreamedResponse($callback);
  291.         }
  293.         $response->setCallback($callback);
  295.         return $response;
  296.     }
  298.     /**
  299.      * Returns a NotFoundHttpException.
  300.      *
  301.      * This will result in a 404 response code. Usage example:
  302.      *
  303.      *     throw $this->createNotFoundException('Page not found!');
  304.      *
  305.      * @final
  306.      */
  307.     protected function createNotFoundException(string $message = 'Not Found', \Throwable $previous = null): NotFoundHttpException
  308.     {
  309.         return new NotFoundHttpException($message, $previous);
  310.     }
  312.     /**
  313.      * Returns an AccessDeniedException.
  314.      *
  315.      * This will result in a 403 response code. Usage example:
  316.      *
  317.      *     throw $this->createAccessDeniedException('Unable to access this page!');
  318.      *
  319.      * @throws \LogicException If the Security component is not available
  320.      *
  321.      * @final
  322.      */
  323.     protected function createAccessDeniedException(string $message = 'Access Denied.', \Throwable $previous = null): AccessDeniedException
  324.     {
  325.         if (!class_exists(AccessDeniedException::class)) {
  326.             throw new \LogicException('You can not use the "createAccessDeniedException" method if the Security component is not available. Try running "composer require symfony/security-bundle".');
  327.         }
  329.         return new AccessDeniedException($message, $previous);
  330.     }
  332.     /**
  333.      * Creates and returns a Form instance from the type of the form.
  334.      *
  335.      * @final
  336.      */
  337.     protected function createForm(string $type, $data = null, array $options = []): FormInterface
  338.     {
  339.         return $this->container->get('form.factory')->create($type, $data, $options);
  340.     }
  342.     /**
  343.      * Creates and returns a form builder instance.
  344.      *
  345.      * @final
  346.      */
  347.     protected function createFormBuilder($data = null, array $options = []): FormBuilderInterface
  348.     {
  349.         return $this->container->get('form.factory')->createBuilder(FormType::class, $data, $options);
  350.     }
  352.     /**
  353.      * Shortcut to return the Doctrine Registry service.
  354.      *
  355.      * @return ManagerRegistry
  356.      *
  357.      * @throws \LogicException If DoctrineBundle is not available
  358.      *
  359.      * @final
  360.      */
  361.     protected function getDoctrine()
  362.     {
  363.         if (!$this->container->has('doctrine')) {
  364.             throw new \LogicException('The DoctrineBundle is not registered in your application. Try running "composer require symfony/orm-pack".');
  365.         }
  367.         return $this->container->get('doctrine');
  368.     }
  370.     /**
  371.      * Get a user from the Security Token Storage.
  372.      *
  373.      * @return UserInterface|object|null
  374.      *
  375.      * @throws \LogicException If SecurityBundle is not available
  376.      *
  377.      * @see TokenInterface::getUser()
  378.      *
  379.      * @final
  380.      */
  381.     protected function getUser()
  382.     {
  383.         if (!$this->container->has('security.token_storage')) {
  384.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  385.         }
  387.         if (null === $token = $this->container->get('security.token_storage')->getToken()) {
  388.             return null;
  389.         }
  391.         if (!\is_object($user = $token->getUser())) {
  392.             // e.g. anonymous authentication
  393.             return null;
  394.         }
  396.         return $user;
  397.     }
  399.     /**
  400.      * Checks the validity of a CSRF token.
  401.      *
  402.      * @param string      $id    The id used when generating the token
  403.      * @param string|null $token The actual token sent with the request that should be validated
  404.      *
  405.      * @final
  406.      */
  407.     protected function isCsrfTokenValid(string $id, ?string $token): bool
  408.     {
  409.         if (!$this->container->has('security.csrf.token_manager')) {
  410.             throw new \LogicException('CSRF protection is not enabled in your application. Enable it with the "csrf_protection" key in "config/packages/framework.yaml".');
  411.         }
  413.         return $this->container->get('security.csrf.token_manager')->isTokenValid(new CsrfToken($id, $token));
  414.     }
  416.     /**
  417.      * Dispatches a message to the bus.
  418.      *
  419.      * @param object|Envelope  $message The message or the message pre-wrapped in an envelope
  420.      * @param StampInterface[] $stamps
  421.      *
  422.      * @final
  423.      */
  424.     protected function dispatchMessage($message, array $stamps = []): Envelope
  425.     {
  426.         if (!$this->container->has('messenger.default_bus')) {
  427.             $message = class_exists(Envelope::class) ? 'You need to define the "messenger.default_bus" configuration option.' : 'Try running "composer require symfony/messenger".';
  428.             throw new \LogicException('The message bus is not enabled in your application. '.$message);
  429.         }
  431.         return $this->container->get('messenger.default_bus')->dispatch($message, $stamps);
  432.     }
  434.     /**
  435.      * Adds a Link HTTP header to the current response.
  436.      *
  437.      * @see https://tools.ietf.org/html/rfc5988
  438.      *
  439.      * @final
  440.      */
  441.     protected function addLink(Request $request, LinkInterface $link)
  442.     {
  443.         if (!class_exists(AddLinkHeaderListener::class)) {
  444.             throw new \LogicException('You can not use the "addLink" method if the WebLink component is not available. Try running "composer require symfony/web-link".');
  445.         }
  447.         if (null === $linkProvider = $request->attributes->get('_links')) {
  448.             $request->attributes->set('_links', new GenericLinkProvider([$link]));
  450.             return;
  451.         }
  453.         $request->attributes->set('_links', $linkProvider->withLink($link));
  454.     }
  455. }