vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Controller/ControllerTrait.php line 284

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\Form\Extension\Core\Type\FormType;
  17. use Symfony\Component\Form\FormBuilderInterface;
  18. use Symfony\Component\Form\FormInterface;
  19. use Symfony\Component\HttpFoundation\BinaryFileResponse;
  20. use Symfony\Component\HttpFoundation\JsonResponse;
  21. use Symfony\Component\HttpFoundation\RedirectResponse;
  22. use Symfony\Component\HttpFoundation\Response;
  23. use Symfony\Component\HttpFoundation\ResponseHeaderBag;
  24. use Symfony\Component\HttpFoundation\StreamedResponse;
  25. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  26. use Symfony\Component\HttpKernel\HttpKernelInterface;
  27. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  28. use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  29. use Symfony\Component\Security\Csrf\CsrfToken;
  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.      * @param string $id The service id
  46.      *
  47.      * @return bool true if the service id is defined, false otherwise
  48.      *
  49.      * @final since version 3.4
  50.      */
  51.     protected function has($id)
  52.     {
  53.         return $this->container->has($id);
  54.     }
  56.     /**
  57.      * Gets a container service by its id.
  58.      *
  59.      * @param string $id The service id
  60.      *
  61.      * @return object The service
  62.      *
  63.      * @final since version 3.4
  64.      */
  65.     protected function get($id)
  66.     {
  67.         return $this->container->get($id);
  68.     }
  70.     /**
  71.      * Generates a URL from the given parameters.
  72.      *
  73.      * @param string $route         The name of the route
  74.      * @param array  $parameters    An array of parameters
  75.      * @param int    $referenceType The type of reference (one of the constants in UrlGeneratorInterface)
  76.      *
  77.      * @return string The generated URL
  78.      *
  79.      * @see UrlGeneratorInterface
  80.      *
  81.      * @final since version 3.4
  82.      */
  83.     protected function generateUrl($route, $parameters = [], $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)
  84.     {
  85.         return $this->container->get('router')->generate($route, $parameters, $referenceType);
  86.     }
  88.     /**
  89.      * Forwards the request to another controller.
  90.      *
  91.      * @param string $controller The controller name (a string like BlogBundle:Post:index)
  92.      * @param array  $path       An array of path parameters
  93.      * @param array  $query      An array of query parameters
  94.      *
  95.      * @return Response A Response instance
  96.      *
  97.      * @final since version 3.4
  98.      */
  99.     protected function forward($controller, array $path = [], array $query = [])
  100.     {
  101.         $request = $this->container->get('request_stack')->getCurrentRequest();
  102.         $path['_forwarded'] = $request->attributes;
  103.         $path['_controller'] = $controller;
  104.         $subRequest = $request->duplicate($query, null, $path);
  106.         return $this->container->get('http_kernel')->handle($subRequest, HttpKernelInterface::SUB_REQUEST);
  107.     }
  109.     /**
  110.      * Returns a RedirectResponse to the given URL.
  111.      *
  112.      * @param string $url    The URL to redirect to
  113.      * @param int    $status The status code to use for the Response
  114.      *
  115.      * @return RedirectResponse
  116.      *
  117.      * @final since version 3.4
  118.      */
  119.     protected function redirect($url, $status = 302)
  120.     {
  121.         return new RedirectResponse($url, $status);
  122.     }
  124.     /**
  125.      * Returns a RedirectResponse to the given route with the given parameters.
  126.      *
  127.      * @param string $route      The name of the route
  128.      * @param array  $parameters An array of parameters
  129.      * @param int    $status     The status code to use for the Response
  130.      *
  131.      * @return RedirectResponse
  132.      *
  133.      * @final since version 3.4
  134.      */
  135.     protected function redirectToRoute($route, array $parameters = [], $status = 302)
  136.     {
  137.         return $this->redirect($this->generateUrl($route, $parameters), $status);
  138.     }
  140.     /**
  141.      * Returns a JsonResponse that uses the serializer component if enabled, or json_encode.
  142.      *
  143.      * @param mixed $data    The response data
  144.      * @param int   $status  The status code to use for the Response
  145.      * @param array $headers Array of extra headers to add
  146.      * @param array $context Context to pass to serializer when using serializer component
  147.      *
  148.      * @return JsonResponse
  149.      *
  150.      * @final since version 3.4
  151.      */
  152.     protected function json($data, $status = 200, $headers = [], $context = [])
  153.     {
  154.         if ($this->container->has('serializer')) {
  155.             $json = $this->container->get('serializer')->serialize($data, 'json', array_merge([
  156.                 'json_encode_options' => JsonResponse::DEFAULT_ENCODING_OPTIONS,
  157.             ], $context));
  159.             return new JsonResponse($json, $status, $headers, true);
  160.         }
  162.         return new JsonResponse($data, $status, $headers);
  163.     }
  165.     /**
  166.      * Returns a BinaryFileResponse object with original or customized file name and disposition header.
  167.      *
  168.      * @param \SplFileInfo|string $file        File object or path to file to be sent as response
  169.      * @param string|null         $fileName    File name to be sent to response or null (will use original file name)
  170.      * @param string              $disposition Disposition of response ("attachment" is default, other type is "inline")
  171.      *
  172.      * @return BinaryFileResponse
  173.      *
  174.      * @final since version 3.4
  175.      */
  176.     protected function file($file, $fileName = null, $disposition = ResponseHeaderBag::DISPOSITION_ATTACHMENT)
  177.     {
  178.         $response = new BinaryFileResponse($file);
  179.         $response->setContentDisposition($disposition, null === $fileName ? $response->getFile()->getFilename() : $fileName);
  181.         return $response;
  182.     }
  184.     /**
  185.      * Adds a flash message to the current session for type.
  186.      *
  187.      * @param string $type    The type
  188.      * @param string $message The message
  189.      *
  190.      * @throws \LogicException
  191.      *
  192.      * @final since version 3.4
  193.      */
  194.     protected function addFlash($type, $message)
  195.     {
  196.         if (!$this->container->has('session')) {
  197.             throw new \LogicException('You can not use the addFlash method if sessions are disabled. Enable them in "config/packages/framework.yaml".');
  198.         }
  200.         $this->container->get('session')->getFlashBag()->add($type, $message);
  201.     }
  203.     /**
  204.      * Checks if the attributes are granted against the current authentication token and optionally supplied subject.
  205.      *
  206.      * @param mixed $attributes The attributes
  207.      * @param mixed $subject    The subject
  208.      *
  209.      * @return bool
  210.      *
  211.      * @throws \LogicException
  212.      *
  213.      * @final since version 3.4
  214.      */
  215.     protected function isGranted($attributes, $subject = null)
  216.     {
  217.         if (!$this->container->has('security.authorization_checker')) {
  218.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  219.         }
  221.         return $this->container->get('security.authorization_checker')->isGranted($attributes, $subject);
  222.     }
  224.     /**
  225.      * Throws an exception unless the attributes are granted against the current authentication token and optionally
  226.      * supplied subject.
  227.      *
  228.      * @param mixed  $attributes The attributes
  229.      * @param mixed  $subject    The subject
  230.      * @param string $message    The message passed to the exception
  231.      *
  232.      * @throws AccessDeniedException
  233.      *
  234.      * @final since version 3.4
  235.      */
  236.     protected function denyAccessUnlessGranted($attributes, $subject = null, $message = 'Access Denied.')
  237.     {
  238.         if (!$this->isGranted($attributes, $subject)) {
  239.             $exception = $this->createAccessDeniedException($message);
  240.             $exception->setAttributes($attributes);
  241.             $exception->setSubject($subject);
  243.             throw $exception;
  244.         }
  245.     }
  247.     /**
  248.      * Returns a rendered view.
  249.      *
  250.      * @param string $view       The view name
  251.      * @param array  $parameters An array of parameters to pass to the view
  252.      *
  253.      * @return string The rendered view
  254.      *
  255.      * @final since version 3.4
  256.      */
  257.     protected function renderView($view, array $parameters = [])
  258.     {
  259.         if ($this->container->has('templating')) {
  260.             return $this->container->get('templating')->render($view, $parameters);
  261.         }
  263.         if (!$this->container->has('twig')) {
  264.             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".');
  265.         }
  267.         return $this->container->get('twig')->render($view, $parameters);
  268.     }
  270.     /**
  271.      * Renders a view.
  272.      *
  273.      * @param string   $view       The view name
  274.      * @param array    $parameters An array of parameters to pass to the view
  275.      * @param Response $response   A response instance
  276.      *
  277.      * @return Response A Response instance
  278.      *
  279.      * @final since version 3.4
  280.      */
  281.     protected function render($view, array $parameters = [], Response $response = null)
  282.     {
  283.         if ($this->container->has('templating')) {
  284.             $content = $this->container->get('templating')->render($view, $parameters);
  285.         } elseif ($this->container->has('twig')) {
  286.             $content = $this->container->get('twig')->render($view, $parameters);
  287.         } else {
  288.             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".');
  289.         }
  291.         if (null === $response) {
  292.             $response = new Response();
  293.         }
  295.         $response->setContent($content);
  297.         return $response;
  298.     }
  300.     /**
  301.      * Streams a view.
  302.      *
  303.      * @param string           $view       The view name
  304.      * @param array            $parameters An array of parameters to pass to the view
  305.      * @param StreamedResponse $response   A response instance
  306.      *
  307.      * @return StreamedResponse A StreamedResponse instance
  308.      *
  309.      * @final since version 3.4
  310.      */
  311.     protected function stream($view, array $parameters = [], StreamedResponse $response = null)
  312.     {
  313.         if ($this->container->has('templating')) {
  314.             $templating = $this->container->get('templating');
  316.             $callback = function () use ($templating, $view, $parameters) {
  317.                 $templating->stream($view, $parameters);
  318.             };
  319.         } elseif ($this->container->has('twig')) {
  320.             $twig = $this->container->get('twig');
  322.             $callback = function () use ($twig, $view, $parameters) {
  323.                 $twig->display($view, $parameters);
  324.             };
  325.         } else {
  326.             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".');
  327.         }
  329.         if (null === $response) {
  330.             return new StreamedResponse($callback);
  331.         }
  333.         $response->setCallback($callback);
  335.         return $response;
  336.     }
  338.     /**
  339.      * Returns a NotFoundHttpException.
  340.      *
  341.      * This will result in a 404 response code. Usage example:
  342.      *
  343.      *     throw $this->createNotFoundException('Page not found!');
  344.      *
  345.      * @param string          $message  A message
  346.      * @param \Exception|null $previous The previous exception
  347.      *
  348.      * @return NotFoundHttpException
  349.      *
  350.      * @final since version 3.4
  351.      */
  352.     protected function createNotFoundException($message = 'Not Found', \Exception $previous = null)
  353.     {
  354.         return new NotFoundHttpException($message, $previous);
  355.     }
  357.     /**
  358.      * Returns an AccessDeniedException.
  359.      *
  360.      * This will result in a 403 response code. Usage example:
  361.      *
  362.      *     throw $this->createAccessDeniedException('Unable to access this page!');
  363.      *
  364.      * @param string          $message  A message
  365.      * @param \Exception|null $previous The previous exception
  366.      *
  367.      * @return AccessDeniedException
  368.      *
  369.      * @throws \LogicException If the Security component is not available
  370.      *
  371.      * @final since version 3.4
  372.      */
  373.     protected function createAccessDeniedException($message = 'Access Denied.', \Exception $previous = null)
  374.     {
  375.         if (!class_exists(AccessDeniedException::class)) {
  376.             throw new \LogicException('You can not use the "createAccessDeniedException" method if the Security component is not available. Try running "composer require symfony/security-bundle".');
  377.         }
  379.         return new AccessDeniedException($message, $previous);
  380.     }
  382.     /**
  383.      * Creates and returns a Form instance from the type of the form.
  384.      *
  385.      * @param string $type    The fully qualified class name of the form type
  386.      * @param mixed  $data    The initial data for the form
  387.      * @param array  $options Options for the form
  388.      *
  389.      * @return FormInterface
  390.      *
  391.      * @final since version 3.4
  392.      */
  393.     protected function createForm($type, $data = null, array $options = [])
  394.     {
  395.         return $this->container->get('form.factory')->create($type, $data, $options);
  396.     }
  398.     /**
  399.      * Creates and returns a form builder instance.
  400.      *
  401.      * @param mixed $data    The initial data for the form
  402.      * @param array $options Options for the form
  403.      *
  404.      * @return FormBuilderInterface
  405.      *
  406.      * @final since version 3.4
  407.      */
  408.     protected function createFormBuilder($data = null, array $options = [])
  409.     {
  410.         return $this->container->get('form.factory')->createBuilder(FormType::class, $data, $options);
  411.     }
  413.     /**
  414.      * Shortcut to return the Doctrine Registry service.
  415.      *
  416.      * @return ManagerRegistry
  417.      *
  418.      * @throws \LogicException If DoctrineBundle is not available
  419.      *
  420.      * @final since version 3.4
  421.      */
  422.     protected function getDoctrine()
  423.     {
  424.         if (!$this->container->has('doctrine')) {
  425.             throw new \LogicException('The DoctrineBundle is not registered in your application. Try running "composer require symfony/orm-pack".');
  426.         }
  428.         return $this->container->get('doctrine');
  429.     }
  431.     /**
  432.      * Get a user from the Security Token Storage.
  433.      *
  434.      * @return mixed
  435.      *
  436.      * @throws \LogicException If SecurityBundle is not available
  437.      *
  438.      * @see TokenInterface::getUser()
  439.      *
  440.      * @final since version 3.4
  441.      */
  442.     protected function getUser()
  443.     {
  444.         if (!$this->container->has('security.token_storage')) {
  445.             throw new \LogicException('The SecurityBundle is not registered in your application. Try running "composer require symfony/security-bundle".');
  446.         }
  448.         if (null === $token = $this->container->get('security.token_storage')->getToken()) {
  449.             return;
  450.         }
  452.         if (!\is_object($user = $token->getUser())) {
  453.             // e.g. anonymous authentication
  454.             return;
  455.         }
  457.         return $user;
  458.     }
  460.     /**
  461.      * Checks the validity of a CSRF token.
  462.      *
  463.      * @param string $id    The id used when generating the token
  464.      * @param string $token The actual token sent with the request that should be validated
  465.      *
  466.      * @return bool
  467.      *
  468.      * @final since version 3.4
  469.      */
  470.     protected function isCsrfTokenValid($id, $token)
  471.     {
  472.         if (!$this->container->has('security.csrf.token_manager')) {
  473.             throw new \LogicException('CSRF protection is not enabled in your application. Enable it with the "csrf_protection" key in "config/packages/framework.yaml".');
  474.         }
  476.         return $this->container->get('security.csrf.token_manager')->isTokenValid(new CsrfToken($id, $token));
  477.     }
  478. }