vendor/symfony/framework-bundle/Controller/ControllerTrait.php line 293

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