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

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\Common\Persistence\ManagerRegistry;
  15. use Psr\Container\ContainerInterface;
  16. use Symfony\Component\HttpFoundation\BinaryFileResponse;
  17. use Symfony\Component\HttpFoundation\JsonResponse;
  18. use Symfony\Component\HttpFoundation\Response;
  19. use Symfony\Component\HttpFoundation\RedirectResponse;
  20. use Symfony\Component\HttpFoundation\ResponseHeaderBag;
  21. use Symfony\Component\HttpFoundation\StreamedResponse;
  22. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  23. use Symfony\Component\HttpKernel\HttpKernelInterface;
  24. use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  25. use Symfony\Component\Security\Csrf\CsrfToken;
  26. use Symfony\Component\Form\Extension\Core\Type\FormType;
  27. use Symfony\Component\Form\FormInterface;
  28. use Symfony\Component\Form\FormBuilderInterface;
  29. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  31. /**
  32.  * Common features needed in controllers.
  33.  *
  34.  * @author Fabien Potencier <fabien@symfony.com>
  35.  *
  36.  * @internal
  37.  *
  38.  * @property ContainerInterface $container
  39.  */
  40. trait ControllerTrait
  41. {
  42.     /**
  43.      * Returns true if the service id is defined.
  44.      *
  45.      * @final
  46.      */
  47.     protected function has(string $id): bool
  48.     {
  49.         return $this->container->has($id);
  50.     }
  52.     /**
  53.      * Gets a container service by its id.
  54.      *
  55.      * @return object The service
  56.      *
  57.      * @final
  58.      */
  59.     protected function get(string $id)
  60.     {
  61.         return $this->container->get($id);
  62.     }
  64.     /**
  65.      * Generates a URL from the given parameters.
  66.      *
  67.      * @see UrlGeneratorInterface
  68.      *
  69.      * @final
  70.      */
  71.     protected function generateUrl(string $route, array $parameters = array(), int $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH): string
  72.     {
  73.         return $this->container->get('router')->generate($route, $parameters, $referenceType);
  74.     }
  76.     /**
  77.      * Forwards the request to another controller.
  78.      *
  79.      * @param string $controller The controller name (a string like Bundle\BlogBundle\Controller\PostController::indexAction)
  80.      *
  81.      * @final
  82.      */
  83.     protected function forward(string $controller, array $path = array(), array $query = array()): Response
  84.     {
  85.         $request = $this->container->get('request_stack')->getCurrentRequest();
  86.         $path['_controller'] = $controller;
  87.         $subRequest = $request->duplicate($query, null, $path);
  89.         return $this->container->get('http_kernel')->handle($subRequest, HttpKernelInterface::SUB_REQUEST);
  90.     }
  92.     /**
  93.      * Returns a RedirectResponse to the given URL.
  94.      *
  95.      * @final
  96.      */
  97.     protected function redirect(string $url, int $status = 302): RedirectResponse
  98.     {
  99.         return new RedirectResponse($url, $status);
  100.     }
  102.     /**
  103.      * Returns a RedirectResponse to the given route with the given parameters.
  104.      *
  105.      * @final
  106.      */
  107.     protected function redirectToRoute(string $route, array $parameters = array(), int $status = 302): RedirectResponse
  108.     {
  109.         return $this->redirect($this->generateUrl($route, $parameters), $status);
  110.     }
  112.     /**
  113.      * Returns a JsonResponse that uses the serializer component if enabled, or json_encode.
  114.      *
  115.      * @final
  116.      */
  117.     protected function json($data, int $status = 200, array $headers = array(), array $context = array()): JsonResponse
  118.     {
  119.         if ($this->container->has('serializer')) {
  120.             $json = $this->container->get('serializer')->serialize($data, 'json', array_merge(array(
  121.                 'json_encode_options' => JsonResponse::DEFAULT_ENCODING_OPTIONS,
  122.             ), $context));
  124.             return new JsonResponse($json, $status, $headers, true);
  125.         }
  127.         return new JsonResponse($data, $status, $headers);
  128.     }
  130.     /**
  131.      * Returns a BinaryFileResponse object with original or customized file name and disposition header.
  132.      *
  133.      * @param \SplFileInfo|string $file File object or path to file to be sent as response
  134.      *
  135.      * @final
  136.      */
  137.     protected function file($file, string $fileName = null, string $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT): BinaryFileResponse
  138.     {
  139.         $response = new BinaryFileResponse($file);
  140.         $response->setContentDisposition($disposition, null === $fileName ? $response->getFile()->getFilename() : $fileName);
  142.         return $response;
  143.     }
  145.     /**
  146.      * Adds a flash message to the current session for type.
  147.      *
  148.      * @throws \LogicException
  149.      *
  150.      * @final
  151.      */
  152.     protected function addFlash(string $type, string $message)
  153.     {
  154.         if (!$this->container->has('session')) {
  155.             throw new \LogicException('You can not use the addFlash method if sessions are disabled. Enable them in "config/packages/framework.yaml".');
  156.         }
  158.         $this->container->get('session')->getFlashBag()->add($type, $message);
  159.     }
  161.     /**
  162.      * Checks if the attributes are granted against the current authentication token and optionally supplied subject.
  163.      *
  164.      * @throws \LogicException
  165.      *
  166.      * @final
  167.      */
  168.     protected function isGranted($attributes, $subject = null): bool
  169.     {
  170.         if (!$this->container->has('security.authorization_checker')) {
  171.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  172.         }
  174.         return $this->container->get('security.authorization_checker')->isGranted($attributes, $subject);
  175.     }
  177.     /**
  178.      * Throws an exception unless the attributes are granted against the current authentication token and optionally
  179.      * supplied subject.
  180.      *
  181.      * @throws AccessDeniedException
  182.      *
  183.      * @final
  184.      */
  185.     protected function denyAccessUnlessGranted($attributes, $subject = null, string $message = 'Access Denied.')
  186.     {
  187.         if (!$this->isGranted($attributes, $subject)) {
  188.             $exception = $this->createAccessDeniedException($message);
  189.             $exception->setAttributes($attributes);
  190.             $exception->setSubject($subject);
  192.             throw $exception;
  193.         }
  194.     }
  196.     /**
  197.      * Returns a rendered view.
  198.      *
  199.      * @final
  200.      */
  201.     protected function renderView(string $view, array $parameters = array()): string
  202.     {
  203.         if ($this->container->has('templating')) {
  204.             return $this->container->get('templating')->render($view, $parameters);
  205.         }
  207.         if (!$this->container->has('twig')) {
  208.             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".');
  209.         }
  211.         return $this->container->get('twig')->render($view, $parameters);
  212.     }
  214.     /**
  215.      * Renders a view.
  216.      *
  217.      * @final
  218.      */
  219.     protected function render(string $view, array $parameters = array(), Response $response = null): Response
  220.     {
  221.         if ($this->container->has('templating')) {
  222.             $content = $this->container->get('templating')->render($view, $parameters);
  223.         } elseif ($this->container->has('twig')) {
  224.             $content = $this->container->get('twig')->render($view, $parameters);
  225.         } else {
  226.             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".');
  227.         }
  229.         if (null === $response) {
  230.             $response = new Response();
  231.         }
  233.         $response->setContent($content);
  235.         return $response;
  236.     }
  238.     /**
  239.      * Streams a view.
  240.      *
  241.      * @final
  242.      */
  243.     protected function stream(string $view, array $parameters = array(), StreamedResponse $response = null): StreamedResponse
  244.     {
  245.         if ($this->container->has('templating')) {
  246.             $templating = $this->container->get('templating');
  248.             $callback = function () use ($templating, $view, $parameters) {
  249.                 $templating->stream($view, $parameters);
  250.             };
  251.         } elseif ($this->container->has('twig')) {
  252.             $twig = $this->container->get('twig');
  254.             $callback = function () use ($twig, $view, $parameters) {
  255.                 $twig->display($view, $parameters);
  256.             };
  257.         } else {
  258.             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".');
  259.         }
  261.         if (null === $response) {
  262.             return new StreamedResponse($callback);
  263.         }
  265.         $response->setCallback($callback);
  267.         return $response;
  268.     }
  270.     /**
  271.      * Returns a NotFoundHttpException.
  272.      *
  273.      * This will result in a 404 response code. Usage example:
  274.      *
  275.      *     throw $this->createNotFoundException('Page not found!');
  276.      *
  277.      * @final
  278.      */
  279.     protected function createNotFoundException(string $message = 'Not Found', \Exception $previous = null): NotFoundHttpException
  280.     {
  281.         return new NotFoundHttpException($message, $previous);
  282.     }
  284.     /**
  285.      * Returns an AccessDeniedException.
  286.      *
  287.      * This will result in a 403 response code. Usage example:
  288.      *
  289.      *     throw $this->createAccessDeniedException('Unable to access this page!');
  290.      *
  291.      * @throws \LogicException If the Security component is not available
  292.      *
  293.      * @final
  294.      */
  295.     protected function createAccessDeniedException(string $message = 'Access Denied.', \Exception $previous = null): AccessDeniedException
  296.     {
  297.         if (!class_exists(AccessDeniedException::class)) {
  298.             throw new \LogicException('You can not use the "createAccessDeniedException" method if the Security component is not available. Try running "composer require symfony/security-bundle".');
  299.         }
  301.         return new AccessDeniedException($message, $previous);
  302.     }
  304.     /**
  305.      * Creates and returns a Form instance from the type of the form.
  306.      *
  307.      * @final
  308.      */
  309.     protected function createForm(string $type, $data = null, array $options = array()): FormInterface
  310.     {
  311.         return $this->container->get('form.factory')->create($type, $data, $options);
  312.     }
  314.     /**
  315.      * Creates and returns a form builder instance.
  316.      *
  317.      * @final
  318.      */
  319.     protected function createFormBuilder($data = null, array $options = array()): FormBuilderInterface
  320.     {
  321.         return $this->container->get('form.factory')->createBuilder(FormType::class, $data, $options);
  322.     }
  324.     /**
  325.      * Shortcut to return the Doctrine Registry service.
  326.      *
  327.      * @throws \LogicException If DoctrineBundle is not available
  328.      *
  329.      * @final
  330.      */
  331.     protected function getDoctrine(): ManagerRegistry
  332.     {
  333.         if (!$this->container->has('doctrine')) {
  334.             throw new \LogicException('The DoctrineBundle is not registered in your application. Try running "composer require symfony/orm-pack".');
  335.         }
  337.         return $this->container->get('doctrine');
  338.     }
  340.     /**
  341.      * Get a user from the Security Token Storage.
  342.      *
  343.      * @return mixed
  344.      *
  345.      * @throws \LogicException If SecurityBundle is not available
  346.      *
  347.      * @see TokenInterface::getUser()
  348.      *
  349.      * @final
  350.      */
  351.     protected function getUser()
  352.     {
  353.         if (!$this->container->has('security.token_storage')) {
  354.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  355.         }
  357.         if (null === $token = $this->container->get('security.token_storage')->getToken()) {
  358.             return;
  359.         }
  361.         if (!is_object($user = $token->getUser())) {
  362.             // e.g. anonymous authentication
  363.             return;
  364.         }
  366.         return $user;
  367.     }
  369.     /**
  370.      * Checks the validity of a CSRF token.
  371.      *
  372.      * @param string      $id    The id used when generating the token
  373.      * @param string|null $token The actual token sent with the request that should be validated
  374.      *
  375.      * @final
  376.      */
  377.     protected function isCsrfTokenValid(string $id, ?string $token): bool
  378.     {
  379.         if (!$this->container->has('security.csrf.token_manager')) {
  380.             throw new \LogicException('CSRF protection is not enabled in your application. Enable it with the "csrf_protection" key in "config/packages/framework.yaml".');
  381.         }
  383.         return $this->container->get('security.csrf.token_manager')->isTokenValid(new CsrfToken($id, $token));
  384.     }
  386.     /**
  387.      * Dispatches a message to the bus.
  388.      *
  389.      * @param object $message The message to dispatch
  390.      *
  391.      * @final
  392.      */
  393.     protected function dispatchMessage($message)
  394.     {
  395.         if (!$this->container->has('message_bus')) {
  396.             throw new \LogicException('The message bus is not enabled in your application. Try running "composer require symfony/messenger".');
  397.         }
  399.         return $this->container->get('message_bus')->dispatch($message);
  400.     }
  401. }