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

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 Symfony\Bundle\FrameworkBundle\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 version 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(string $view, array $parameters = [], Response $response = null): Response
  229.     {
  230.         if ($this->container->has('templating')) {
  231.             @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);
  233.             $content = $this->container->get('templating')->render($view, $parameters);
  234.         } elseif ($this->container->has('twig')) {
  235.             $content = $this->container->get('twig')->render($view, $parameters);
  236.         } else {
  237.             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".');
  238.         }
  240.         if (null === $response) {
  241.             $response = new Response();
  242.         }
  244.         $response->setContent($content);
  246.         return $response;
  247.     }
  249.     /**
  250.      * Streams a view.
  251.      *
  252.      * @final
  253.      */
  254.     protected function stream(string $view, array $parameters = [], StreamedResponse $response = null): StreamedResponse
  255.     {
  256.         if ($this->container->has('templating')) {
  257.             @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);
  259.             $templating = $this->container->get('templating');
  261.             $callback = function () use ($templating, $view, $parameters) {
  262.                 $templating->stream($view, $parameters);
  263.             };
  264.         } elseif ($this->container->has('twig')) {
  265.             $twig = $this->container->get('twig');
  267.             $callback = function () use ($twig, $view, $parameters) {
  268.                 $twig->display($view, $parameters);
  269.             };
  270.         } else {
  271.             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".');
  272.         }
  274.         if (null === $response) {
  275.             return new StreamedResponse($callback);
  276.         }
  278.         $response->setCallback($callback);
  280.         return $response;
  281.     }
  283.     /**
  284.      * Returns a NotFoundHttpException.
  285.      *
  286.      * This will result in a 404 response code. Usage example:
  287.      *
  288.      *     throw $this->createNotFoundException('Page not found!');
  289.      *
  290.      * @final
  291.      */
  292.     protected function createNotFoundException(string $message = 'Not Found', \Throwable $previous = null): NotFoundHttpException
  293.     {
  294.         return new NotFoundHttpException($message, $previous);
  295.     }
  297.     /**
  298.      * Returns an AccessDeniedException.
  299.      *
  300.      * This will result in a 403 response code. Usage example:
  301.      *
  302.      *     throw $this->createAccessDeniedException('Unable to access this page!');
  303.      *
  304.      * @throws \LogicException If the Security component is not available
  305.      *
  306.      * @final
  307.      */
  308.     protected function createAccessDeniedException(string $message = 'Access Denied.', \Throwable $previous = null): AccessDeniedException
  309.     {
  310.         if (!class_exists(AccessDeniedException::class)) {
  311.             throw new \LogicException('You can not use the "createAccessDeniedException" method if the Security component is not available. Try running "composer require symfony/security-bundle".');
  312.         }
  314.         return new AccessDeniedException($message, $previous);
  315.     }
  317.     /**
  318.      * Creates and returns a Form instance from the type of the form.
  319.      *
  320.      * @final
  321.      */
  322.     protected function createForm(string $type, $data = null, array $options = []): FormInterface
  323.     {
  324.         return $this->container->get('form.factory')->create($type, $data, $options);
  325.     }
  327.     /**
  328.      * Creates and returns a form builder instance.
  329.      *
  330.      * @final
  331.      */
  332.     protected function createFormBuilder($data = null, array $options = []): FormBuilderInterface
  333.     {
  334.         return $this->container->get('form.factory')->createBuilder(FormType::class, $data, $options);
  335.     }
  337.     /**
  338.      * Shortcut to return the Doctrine Registry service.
  339.      *
  340.      * @return ManagerRegistry
  341.      *
  342.      * @throws \LogicException If DoctrineBundle is not available
  343.      *
  344.      * @final
  345.      */
  346.     protected function getDoctrine()
  347.     {
  348.         if (!$this->container->has('doctrine')) {
  349.             throw new \LogicException('The DoctrineBundle is not registered in your application. Try running "composer require symfony/orm-pack".');
  350.         }
  352.         return $this->container->get('doctrine');
  353.     }
  355.     /**
  356.      * Get a user from the Security Token Storage.
  357.      *
  358.      * @return UserInterface|object|null
  359.      *
  360.      * @throws \LogicException If SecurityBundle is not available
  361.      *
  362.      * @see TokenInterface::getUser()
  363.      *
  364.      * @final
  365.      */
  366.     protected function getUser()
  367.     {
  368.         if (!$this->container->has('security.token_storage')) {
  369.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  370.         }
  372.         if (null === $token = $this->container->get('security.token_storage')->getToken()) {
  373.             return null;
  374.         }
  376.         if (!\is_object($user = $token->getUser())) {
  377.             // e.g. anonymous authentication
  378.             return null;
  379.         }
  381.         return $user;
  382.     }
  384.     /**
  385.      * Checks the validity of a CSRF token.
  386.      *
  387.      * @param string      $id    The id used when generating the token
  388.      * @param string|null $token The actual token sent with the request that should be validated
  389.      *
  390.      * @final
  391.      */
  392.     protected function isCsrfTokenValid(string $id, ?string $token): bool
  393.     {
  394.         if (!$this->container->has('security.csrf.token_manager')) {
  395.             throw new \LogicException('CSRF protection is not enabled in your application. Enable it with the "csrf_protection" key in "config/packages/framework.yaml".');
  396.         }
  398.         return $this->container->get('security.csrf.token_manager')->isTokenValid(new CsrfToken($id, $token));
  399.     }
  401.     /**
  402.      * Dispatches a message to the bus.
  403.      *
  404.      * @param object|Envelope  $message The message or the message pre-wrapped in an envelope
  405.      * @param StampInterface[] $stamps
  406.      *
  407.      * @final
  408.      */
  409.     protected function dispatchMessage($message, array $stamps = []): Envelope
  410.     {
  411.         if (!$this->container->has('messenger.default_bus')) {
  412.             $message = class_exists(Envelope::class) ? 'You need to define the "messenger.default_bus" configuration option.' : 'Try running "composer require symfony/messenger".';
  413.             throw new \LogicException('The message bus is not enabled in your application. '.$message);
  414.         }
  416.         return $this->container->get('messenger.default_bus')->dispatch($message, $stamps);
  417.     }
  419.     /**
  420.      * Adds a Link HTTP header to the current response.
  421.      *
  422.      * @see https://tools.ietf.org/html/rfc5988
  423.      *
  424.      * @final
  425.      */
  426.     protected function addLink(Request $request, LinkInterface $link)
  427.     {
  428.         if (!class_exists(AddLinkHeaderListener::class)) {
  429.             throw new \LogicException('You can not use the "addLink" method if the WebLink component is not available. Try running "composer require symfony/web-link".');
  430.         }
  432.         if (null === $linkProvider = $request->attributes->get('_links')) {
  433.             $request->attributes->set('_links', new GenericLinkProvider([$link]));
  435.             return;
  436.         }
  438.         $request->attributes->set('_links', $linkProvider->withLink($link));
  439.     }
  440. }