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