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

  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\JsonResponse;
  22. use Symfony\Component\HttpFoundation\RedirectResponse;
  23. use Symfony\Component\HttpFoundation\Request;
  24. use Symfony\Component\HttpFoundation\Response;
  25. use Symfony\Component\HttpFoundation\ResponseHeaderBag;
  26. use Symfony\Component\HttpFoundation\StreamedResponse;
  27. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  28. use Symfony\Component\HttpKernel\HttpKernelInterface;
  29. use Symfony\Component\Messenger\Envelope;
  30. use Symfony\Component\Messenger\Stamp\StampInterface;
  31. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  32. use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  33. use Symfony\Component\Security\Core\User\UserInterface;
  34. use Symfony\Component\Security\Csrf\CsrfToken;
  35. use Symfony\Component\WebLink\EventListener\AddLinkHeaderListener;
  36. use Symfony\Component\WebLink\GenericLinkProvider;
  38. /**
  39.  * Common features needed in controllers.
  40.  *
  41.  * @author Fabien Potencier <fabien@symfony.com>
  42.  *
  43.  * @internal
  44.  *
  45.  * @property ContainerInterface $container
  46.  */
  47. trait ControllerTrait
  48. {
  49.     /**
  50.      * Returns true if the service id is defined.
  51.      *
  52.      * @final
  53.      */
  54.     protected function has(string $id): bool
  55.     {
  56.         return $this->container->has($id);
  57.     }
  59.     /**
  60.      * Gets a container service by its id.
  61.      *
  62.      * @return object The service
  63.      *
  64.      * @final
  65.      */
  66.     protected function get(string $id)
  67.     {
  68.         return $this->container->get($id);
  69.     }
  71.     /**
  72.      * Generates a URL from the given parameters.
  73.      *
  74.      * @see UrlGeneratorInterface
  75.      *
  76.      * @final
  77.      */
  78.     protected function generateUrl(string $route, array $parameters = [], int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string
  79.     {
  80.         return $this->container->get('router')->generate($route, $parameters, $referenceType);
  81.     }
  83.     /**
  84.      * Forwards the request to another controller.
  85.      *
  86.      * @param string $controller The controller name (a string like Bundle\BlogBundle\Controller\PostController::indexAction)
  87.      *
  88.      * @final
  89.      */
  90.     protected function forward(string $controller, array $path = [], array $query = []): Response
  91.     {
  92.         $request = $this->container->get('request_stack')->getCurrentRequest();
  93.         $path['_controller'] = $controller;
  94.         $subRequest = $request->duplicate($query, null, $path);
  96.         return $this->container->get('http_kernel')->handle($subRequest, HttpKernelInterface::SUB_REQUEST);
  97.     }
  99.     /**
  100.      * Returns a RedirectResponse to the given URL.
  101.      *
  102.      * @final
  103.      */
  104.     protected function redirect(string $url, int $status = 302): RedirectResponse
  105.     {
  106.         return new RedirectResponse($url, $status);
  107.     }
  109.     /**
  110.      * Returns a RedirectResponse to the given route with the given parameters.
  111.      *
  112.      * @final
  113.      */
  114.     protected function redirectToRoute(string $route, array $parameters = [], int $status = 302): RedirectResponse
  115.     {
  116.         return $this->redirect($this->generateUrl($route, $parameters), $status);
  117.     }
  119.     /**
  120.      * Returns a JsonResponse that uses the serializer component if enabled, or json_encode.
  121.      *
  122.      * @final
  123.      */
  124.     protected function json($data, int $status = 200, array $headers = [], array $context = []): JsonResponse
  125.     {
  126.         if ($this->container->has('serializer')) {
  127.             $json = $this->container->get('serializer')->serialize($data, 'json', array_merge([
  128.                 'json_encode_options' => JsonResponse::DEFAULT_ENCODING_OPTIONS,
  129.             ], $context));
  131.             return new JsonResponse($json, $status, $headers, true);
  132.         }
  134.         return new JsonResponse($data, $status, $headers);
  135.     }
  137.     /**
  138.      * Returns a BinaryFileResponse object with original or customized file name and disposition header.
  139.      *
  140.      * @param \SplFileInfo|string $file File object or path to file to be sent as response
  141.      *
  142.      * @final
  143.      */
  144.     protected function file($file, string $fileName = null, string $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT): BinaryFileResponse
  145.     {
  146.         $response = new BinaryFileResponse($file);
  147.         $response->setContentDisposition($disposition, null === $fileName ? $response->getFile()->getFilename() : $fileName);
  149.         return $response;
  150.     }
  152.     /**
  153.      * Adds a flash message to the current session for type.
  154.      *
  155.      * @throws \LogicException
  156.      *
  157.      * @final
  158.      */
  159.     protected function addFlash(string $type, $message)
  160.     {
  161.         if (!$this->container->has('session')) {
  162.             throw new \LogicException('You can not use the addFlash method if sessions are disabled. Enable them in "config/packages/framework.yaml".');
  163.         }
  165.         $this->container->get('session')->getFlashBag()->add($type, $message);
  166.     }
  168.     /**
  169.      * Checks if the attributes are granted against the current authentication token and optionally supplied subject.
  170.      *
  171.      * @throws \LogicException
  172.      *
  173.      * @final
  174.      */
  175.     protected function isGranted($attributes, $subject = null): bool
  176.     {
  177.         if (!$this->container->has('security.authorization_checker')) {
  178.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  179.         }
  181.         return $this->container->get('security.authorization_checker')->isGranted($attributes, $subject);
  182.     }
  184.     /**
  185.      * Throws an exception unless the attributes are granted against the current authentication token and optionally
  186.      * supplied subject.
  187.      *
  188.      * @throws AccessDeniedException
  189.      *
  190.      * @final
  191.      */
  192.     protected function denyAccessUnlessGranted($attributes, $subject = null, string $message = 'Access Denied.')
  193.     {
  194.         if (!$this->isGranted($attributes, $subject)) {
  195.             $exception = $this->createAccessDeniedException($message);
  196.             $exception->setAttributes($attributes);
  197.             $exception->setSubject($subject);
  199.             throw $exception;
  200.         }
  201.     }
  203.     /**
  204.      * Returns a rendered view.
  205.      *
  206.      * @final
  207.      */
  208.     protected function renderView(string $view, array $parameters = []): string
  209.     {
  210.         if ($this->container->has('templating')) {
  211.             @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);
  213.             return $this->container->get('templating')->render($view, $parameters);
  214.         }
  216.         if (!$this->container->has('twig')) {
  217.             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".');
  218.         }
  220.         return $this->container->get('twig')->render($view, $parameters);
  221.     }
  223.     /**
  224.      * Renders a view.
  225.      *
  226.      * @final
  227.      */
  228.     protected function render(
  229.         string $view,
  230.         array $parameters = [],
  231.         Response $response = null,
  232.         ?int $responseCode = null
  233.     ): Response {
  234.         if ($this->container->has('templating')) {
  235.             @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);
  237.             $content = $this->container->get('templating')->render($view, $parameters);
  238.         } elseif ($this->container->has('twig')) {
  239.             $content = $this->container->get('twig')->render($view, $parameters);
  240.         } else {
  241.             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".');
  242.         }
  244.         if (null === $response) {
  245.             $response = new Response();
  246.         }
  248.         $response->setContent($content);
  249.         if ($responseCode !== null) {
  250.             $response->setStatusCode($responseCode);
  251.         }
  253.         return $response;
  254.     }
  256.     /**
  257.      * Streams a view.
  258.      *
  259.      * @final
  260.      */
  261.     protected function stream(string $view, array $parameters = [], StreamedResponse $response = null): StreamedResponse
  262.     {
  263.         if ($this->container->has('templating')) {
  264.             @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);
  266.             $templating = $this->container->get('templating');
  268.             $callback = function () use ($templating, $view, $parameters) {
  269.                 $templating->stream($view, $parameters);
  270.             };
  271.         } elseif ($this->container->has('twig')) {
  272.             $twig = $this->container->get('twig');
  274.             $callback = function () use ($twig, $view, $parameters) {
  275.                 $twig->display($view, $parameters);
  276.             };
  277.         } else {
  278.             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".');
  279.         }
  281.         if (null === $response) {
  282.             return new StreamedResponse($callback);
  283.         }
  285.         $response->setCallback($callback);
  287.         return $response;
  288.     }
  290.     /**
  291.      * Returns a NotFoundHttpException.
  292.      *
  293.      * This will result in a 404 response code. Usage example:
  294.      *
  295.      *     throw $this->createNotFoundException('Page not found!');
  296.      *
  297.      * @final
  298.      */
  299.     protected function createNotFoundException(string $message = 'Not Found', \Throwable $previous = null): NotFoundHttpException
  300.     {
  301.         return new NotFoundHttpException($message, $previous);
  302.     }
  304.     /**
  305.      * Returns an AccessDeniedException.
  306.      *
  307.      * This will result in a 403 response code. Usage example:
  308.      *
  309.      *     throw $this->createAccessDeniedException('Unable to access this page!');
  310.      *
  311.      * @throws \LogicException If the Security component is not available
  312.      *
  313.      * @final
  314.      */
  315.     protected function createAccessDeniedException(string $message = 'Access Denied.', \Throwable $previous = null): AccessDeniedException
  316.     {
  317.         if (!class_exists(AccessDeniedException::class)) {
  318.             throw new \LogicException('You can not use the "createAccessDeniedException" method if the Security component is not available. Try running "composer require symfony/security-bundle".');
  319.         }
  321.         return new AccessDeniedException($message, $previous);
  322.     }
  324.     /**
  325.      * Creates and returns a Form instance from the type of the form.
  326.      *
  327.      * @final
  328.      */
  329.     protected function createForm(string $type, $data = null, array $options = []): FormInterface
  330.     {
  331.         return $this->container->get('form.factory')->create($type, $data, $options);
  332.     }
  334.     /**
  335.      * Creates and returns a form builder instance.
  336.      *
  337.      * @final
  338.      */
  339.     protected function createFormBuilder($data = null, array $options = []): FormBuilderInterface
  340.     {
  341.         return $this->container->get('form.factory')->createBuilder(FormType::class, $data, $options);
  342.     }
  344.     /**
  345.      * Shortcut to return the Doctrine Registry service.
  346.      *
  347.      * @return ManagerRegistry
  348.      *
  349.      * @throws \LogicException If DoctrineBundle is not available
  350.      *
  351.      * @final
  352.      */
  353.     protected function getDoctrine()
  354.     {
  355.         if (!$this->container->has('doctrine')) {
  356.             throw new \LogicException('The DoctrineBundle is not registered in your application. Try running "composer require symfony/orm-pack".');
  357.         }
  359.         return $this->container->get('doctrine');
  360.     }
  362.     /**
  363.      * Get a user from the Security Token Storage.
  364.      *
  365.      * @return UserInterface|object|null
  366.      *
  367.      * @throws \LogicException If SecurityBundle is not available
  368.      *
  369.      * @see TokenInterface::getUser()
  370.      *
  371.      * @final
  372.      */
  373.     protected function getUser()
  374.     {
  375.         if (!$this->container->has('security.token_storage')) {
  376.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  377.         }
  379.         if (null === $token = $this->container->get('security.token_storage')->getToken()) {
  380.             return null;
  381.         }
  383.         if (!\is_object($user = $token->getUser())) {
  384.             // e.g. anonymous authentication
  385.             return null;
  386.         }
  388.         return $user;
  389.     }
  391.     /**
  392.      * Checks the validity of a CSRF token.
  393.      *
  394.      * @param string      $id    The id used when generating the token
  395.      * @param string|null $token The actual token sent with the request that should be validated
  396.      *
  397.      * @final
  398.      */
  399.     protected function isCsrfTokenValid(string $id, ?string $token): bool
  400.     {
  401.         if (!$this->container->has('security.csrf.token_manager')) {
  402.             throw new \LogicException('CSRF protection is not enabled in your application. Enable it with the "csrf_protection" key in "config/packages/framework.yaml".');
  403.         }
  405.         return $this->container->get('security.csrf.token_manager')->isTokenValid(new CsrfToken($id, $token));
  406.     }
  408.     /**
  409.      * Dispatches a message to the bus.
  410.      *
  411.      * @param object|Envelope  $message The message or the message pre-wrapped in an envelope
  412.      * @param StampInterface[] $stamps
  413.      *
  414.      * @final
  415.      */
  416.     protected function dispatchMessage($message, array $stamps = []): Envelope
  417.     {
  418.         if (!$this->container->has('messenger.default_bus')) {
  419.             $message = class_exists(Envelope::class) ? 'You need to define the "messenger.default_bus" configuration option.' : 'Try running "composer require symfony/messenger".';
  420.             throw new \LogicException('The message bus is not enabled in your application. '.$message);
  421.         }
  423.         return $this->container->get('messenger.default_bus')->dispatch($message, $stamps);
  424.     }
  426.     /**
  427.      * Adds a Link HTTP header to the current response.
  428.      *
  429.      * @see https://tools.ietf.org/html/rfc5988
  430.      *
  431.      * @final
  432.      */
  433.     protected function addLink(Request $request, LinkInterface $link)
  434.     {
  435.         if (!class_exists(AddLinkHeaderListener::class)) {
  436.             throw new \LogicException('You can not use the "addLink" method if the WebLink component is not available. Try running "composer require symfony/web-link".');
  437.         }
  439.         if (null === $linkProvider = $request->attributes->get('_links')) {
  440.             $request->attributes->set('_links', new GenericLinkProvider([$link]));
  442.             return;
  443.         }
  445.         $request->attributes->set('_links', $linkProvider->withLink($link));
  446.     }
  447. }