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

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