ecommerce121/util-bundle/Controller/ControllerBase.php line 457

Open in your IDE?
  1. <?php
  3. namespace Ecommerce121\UtilBundle\Controller;
  5. use App\Entity\User;
  6. use App\Security\Voter\UserPermissionVoter;
  7. use App\ValueObject\UserPermission;
  8. use App\ValueObject\UserRoles;
  9. use Ecommerce121\UtilBundle\Http\JsonResponse;
  10. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  11. use Symfony\Component\Form\Form;
  12. use Symfony\Component\Form\FormBuilder;
  13. use Symfony\Component\Form\FormTypeInterface;
  14. use Symfony\Component\HttpFoundation\RedirectResponse;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\Response;
  17. use Symfony\Component\HttpFoundation\StreamedResponse;
  18. use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
  19. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  20. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  21. use Symfony\Component\Security\Core\Exception\AccessDeniedException;
  22. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  23. use Symfony\Component\Validator\Validator\ValidatorInterface;
  25. /**
  26.  * Base class with convenient utility methods for controllers.
  27.  */
  28. class ControllerBase
  29. {
  30.     /**
  31.      * @var ControllerUtil
  32.      */
  33.     private $controllerUtil;
  35.     /**
  36.      * Constructor.
  37.      *
  38.      * @param ControllerUtil $controllerUtil
  39.      */
  40.     public function __construct(ControllerUtil $controllerUtil)
  41.     {
  42.         $this->controllerUtil = $controllerUtil;
  43.     }
  45.     /**
  46.      * Returns a NotFoundHttpException.
  47.      *
  48.      * This will result in a 404 response code. Usage example:
  49.      * <code>
  50.      *     throw $this->createNotFoundException('Page not found!');
  51.      * </code>
  52.      *
  53.      * @param string          $message  An error message
  54.      * @param \Exception|null $previous The previous exception
  55.      *
  56.      * @return NotFoundHttpException
  57.      */
  58.     protected function createNotFoundException($message = 'Not Found', \Exception $previous = null)
  59.     {
  60.         return new NotFoundHttpException($message, $previous);
  61.     }
  63.     /**
  64.      * Returns an AccessDeniedException.
  65.      *
  66.      * This will result in a 403 response code. Usage example:
  67.      * <code>
  68.      *     throw $this->createAccessDeniedException('Unable to access this page!');
  69.      * </code>
  70.      *
  71.      * @param string          $message  An error message
  72.      * @param \Exception|null $previous The previous exception
  73.      *
  74.      * @return AccessDeniedException
  75.      */
  76.     protected function createAccessDeniedException($message = 'Access Denied', \Exception $previous = null)
  77.     {
  78.         return new AccessDeniedException($message, $previous);
  79.     }
  81.     /**
  82.      * Returns a RedirectResponse to the given URL.
  83.      *
  84.      * @param string $url    The URL to redirect to
  85.      * @param int    $status The status code to use for the Response
  86.      *
  87.      * @return RedirectResponse
  88.      */
  89.     protected function redirect($url, $status = 302)
  90.     {
  91.         return new RedirectResponse($url, $status);
  92.     }
  94.     /**
  95.      * Redirects user to 404 page unless the request is an Ajax request.
  96.      *
  97.      * @param Request $request Http request.
  98.      *
  99.      * @throws NotFoundHttpException if the request is not an ajax request
  100.      */
  101.     protected function forward404UnlessIsAjaxRequest(Request $request)
  102.     {
  103.         if (!$request->isXmlHttpRequest()) {
  104.             throw $this->createNotFoundException();
  105.         }
  106.     }
  108.     /**
  109.      * Redirects user to 404 page if the condition is met.
  110.      *
  111.      * @param bool   $condition Condition
  112.      * @param string $message   Message to return in the 404 error
  113.      *
  114.      * @throws NotFoundHttpException if the $condition is met
  115.      */
  116.     protected function forward404If($condition, $message = 'Not Found')
  117.     {
  118.         if ($condition) {
  119.             throw $this->createNotFoundException($message);
  120.         }
  121.     }
  123.     /**
  124.      * Redirects user to 404 page unless the condition is met.
  125.      *
  126.      * @param mixed  $condition Condition
  127.      * @param string $message   Message to return in the 404 error
  128.      *
  129.      * @throws NotFoundHttpException if the $condition is not met
  130.      */
  131.     protected function forward404Unless($condition, $message = 'Not Found')
  132.     {
  133.         if (!$condition) {
  134.             throw $this->createNotFoundException($message);
  135.         }
  136.     }
  138.     /**
  139.      * Returns a json response with a json encoded array.
  140.      *
  141.      * @param array $result Array to encode to Json
  142.      *
  143.      * @return JsonResponse Json encoded response
  144.      */
  145.     protected function json(array $result = array())
  146.     {
  147.         return new JsonResponse($result);
  148.     }
  150.     /**
  151.      * Returns a json response that contains an html view and a json encoded array.
  152.      *
  153.      * @param string $viewName       View name to render
  154.      * @param array  $viewParameters View parameters
  155.      * @param array  $result         Array to encode to Json
  156.      *
  157.      * @return JsonResponse Json encoded response
  158.      */
  159.     protected function jsonView($viewName, array $viewParameters = array(), array $result = array())
  160.     {
  161.         $html = $this->renderView($viewName, $viewParameters);
  162.         $result = array_merge($result, ['html' => $html]);
  164.         return $this->jsonResult($result);
  165.     }
  167.     /**
  168.      * Returns an excel file to be downloaded.
  169.      *
  170.      * @param string $viewName       Excel html view name to render
  171.      * @param string $filename       Downloaded file name
  172.      * @param array  $viewParameters View parameters
  173.      *
  174.      * @return Response
  175.      */
  176.     protected function excelView($viewName, $filename, $viewParameters = array())
  177.     {
  178.         $response = $this->render($viewName, $viewParameters);
  179.         $response->headers->set('Content-Type', 'application/vnd.ms-excel;charset=utf-8');
  180.         $response->headers->set('Content-Disposition', 'attachment;filename='.$filename);
  182.         return $response;
  183.     }
  185.     /**
  186.      * Generates a URL from the given parameters.
  187.      *
  188.      * @param string         $route         The name of the route
  189.      * @param mixed          $parameters    An array of parameters
  190.      * @param Boolean|string $referenceType The type of reference (one of the constants in UrlGeneratorInterface)
  191.      *
  192.      * @return string The generated URL
  193.      *
  194.      * @see UrlGeneratorInterface
  195.      */
  196.     protected function generateUrl($route, $parameters = array(), $referenceType = UrlGeneratorInterface::ABSOLUTE_PATH)
  197.     {
  198.         return $this->controllerUtil->generateUrl($route, $parameters, $referenceType);
  199.     }
  201.     /**
  202.      * Forwards the request to another controller.
  203.      *
  204.      * @param Request $request    The current request
  205.      * @param string  $controller The controller name (a string like BlogBundle:Post:index)
  206.      * @param array   $path       An array of path parameters
  207.      * @param array   $query      An array of query parameters
  208.      *
  209.      * @return Response A Response instance
  210.      */
  211.     protected function forward(Request $request, $controller, array $path = array(), array $query = array())
  212.     {
  213.         return $this->controllerUtil->forward($request, $controller, $path, $query);
  214.     }
  216.     /**
  217.      * Returns a rendered view.
  218.      *
  219.      * @param string $view       The view name
  220.      * @param array  $parameters An array of parameters to pass to the view
  221.      *
  222.      * @return string The rendered view
  223.      */
  224.     protected function renderView($view, array $parameters = array())
  225.     {
  226.         return $this->controllerUtil->renderView($view, $parameters);
  227.     }
  229.     /**
  230.      * Renders a view.
  231.      *
  232.      * @param string   $view       The view name
  233.      * @param array    $parameters An array of parameters to pass to the view
  234.      * @param Response $response   A response instance
  235.      *
  236.      * @return Response A Response instance
  237.      */
  238.     protected function render($view, array $parameters = array(), Response $response = null)
  239.     {
  240.         return $this->controllerUtil->render($view, $parameters, $response);
  241.     }
  243.     /**
  244.      * Streams a view.
  245.      *
  246.      * @param string           $view       The view name
  247.      * @param array            $parameters An array of parameters to pass to the view
  248.      * @param StreamedResponse $response   A response instance
  249.      *
  250.      * @return StreamedResponse A StreamedResponse instance
  251.      */
  252.     protected function stream($view, array $parameters = array(), StreamedResponse $response = null)
  253.     {
  254.         return $this->controllerUtil->stream($view, $parameters, $response);
  255.     }
  257.     /**
  258.      * Creates and returns a Form instance from the type of the form.
  259.      *
  260.      * @param string|FormTypeInterface $type    The built type of the form
  261.      * @param mixed                    $data    The initial data for the form
  262.      * @param array                    $options Options for the form
  263.      *
  264.      * @return Form
  265.      */
  266.     protected function createForm($type, $data = null, array $options = array())
  267.     {
  268.         return $this->controllerUtil->createForm($type, $data, $options);
  269.     }
  271.     /**
  272.      * Creates and returns a form builder instance.
  273.      *
  274.      * @param mixed $data    The initial data for the form
  275.      * @param array $options Options for the form
  276.      *
  277.      * @return FormBuilder
  278.      */
  279.     protected function createFormBuilder($data = null, array $options = array())
  280.     {
  281.         return $this->controllerUtil->createFormBuilder($data, $options);
  282.     }
  284.     /**
  285.      * Gets doctrine entity manager.
  286.      *
  287.      * @return \Doctrine\ORM\EntityManagerInterface Doctrine's entity manager
  288.      */
  289.     protected function getEntityManager()
  290.     {
  291.         return $this->controllerUtil->getEntityManager();
  292.     }
  294.     /**
  295.      * Gets a doctrine's entity proxy for use without loading object from database.
  296.      *
  297.      * @param string $entityName Entity class name (e.g. MyNeeds:User)
  298.      * @param string $id         Entity database identifier
  299.      *
  300.      * @return object Entity proxy
  301.      */
  302.     protected function getEntityReference($entityName, $id)
  303.     {
  304.         return $this->controllerUtil->getEntityReference($entityName, $id);
  305.     }
  307.     /**
  308.      * Translates the given message.
  309.      *
  310.      * @param string $id         The message id (may also be an object that can be cast to string)
  311.      * @param array  $parameters An array of parameters for the message
  312.      * @param string $domain     The domain for the message
  313.      * @param string $locale     The locale
  314.      *
  315.      * @return string The translated string
  316.      */
  317.     protected function trans($id, array $parameters = array(), $domain = 'messages', $locale = null)
  318.     {
  319.         return $this->controllerUtil->trans($id, $parameters, $domain, $locale);
  320.     }
  322.     /**
  323.      * Translates the given choice message by choosing a translation according to a number.
  324.      *
  325.      * @param string $id         The message id (may also be an object that can be cast to string)
  326.      * @param int    $number     The number to use to find the indice of the message
  327.      * @param array  $parameters An array of parameters for the message
  328.      * @param string $domain     The domain for the message
  329.      * @param string $locale     The locale
  330.      *
  331.      * @return string The translated string
  332.      */
  333.     protected function transChoice($id, $number, array $parameters = array(), $domain = 'messages', $locale = null)
  334.     {
  335.         return $this->controllerUtil->transChoice($id, $number, $parameters, $domain, $locale);
  336.     }
  338.     /**
  339.      * Get a user from the TokenStorage.
  340.      *
  341.      * @return mixed
  342.      *
  343.      * @throws \LogicException If SecurityBundle is not available
  344.      *
  345.      * @see Symfony\Component\Security\Core\Authentication\Token\TokenInterface::getUser()
  346.      */
  347.     protected function getUser(): ?User
  348.     {
  349.         return $this->controllerUtil->getUser();
  350.     }
  352.     /**
  353.      * Gets the validator component.
  354.      *
  355.      * @return ValidatorInterface
  356.      */
  357.     protected function getValidator()
  358.     {
  359.         return $this->controllerUtil->getValidator();
  360.     }
  362.     /**
  363.      * Gets the event dispatcher component.
  364.      *
  365.      * @return EventDispatcherInterface
  366.      */
  367.     protected function getEventDispatcher()
  368.     {
  369.         return $this->controllerUtil->getEventDispatcher();
  370.     }
  372.     /**
  373.      * Dispatchs an event in the event dispatcher.
  374.      *
  375.      * @param string     $eventName The name of the event
  376.      * @param object|null $event     The event object to be dispatched
  377.      */
  378.     protected function dispatchEvent($eventName, $event = null)
  379.     {
  380.         $this->controllerUtil->getEventDispatcher()->dispatch($event, $eventName);
  381.     }
  383.     /**
  384.      * Gets the controllerUtil object.
  385.      *
  386.      * @return ControllerUtil
  387.      */
  388.     protected function getControllerUtil()
  389.     {
  390.         return $this->controllerUtil;
  391.     }
  393.     /**
  394.      * Gets the token storage component.
  395.      *
  396.      * @return TokenStorageInterface
  397.      */
  398.     protected function getTokenStorage()
  399.     {
  400.         return $this->controllerUtil->getTokenStorage();
  401.     }
  403.     /**
  404.      * Gets the Symfony kernel root dir.
  405.      *
  406.      * @return string
  407.      */
  408.     protected function getKernelRootDir()
  409.     {
  410.         return $this->controllerUtil->getKernelRootDir();
  411.     }
  413.     /**
  414.      * Gets the project uploads path.
  415.      *
  416.      * @return string
  417.      */
  418.     protected function getUploadsPath()
  419.     {  
  420.         return $this->getKernelRootDir().'/publc/uploads/';
  421.     }
  423.     
  424.     /**
  425.      * @return JsonResponse
  426.      */
  427.     protected function jsonResult(array $data = [])
  428.     {
  429.         return $this->json([
  430.             'hasError' => false,
  431.             'result' => $data
  432.         ]);
  433.     }
  435.     /**
  436.      * @return JsonResponse
  437.      */    
  438.     protected function jsonError($message = '', $code = -1)
  439.     {
  440.         $data = [
  441.             'hasError' => true,
  442.             'error' => [
  443.                 'message' => $message,
  444.                 'code' => $code
  445.             ]
  446.         ];
  448.         return $this->json($data);
  449.     }
  451.     /**
  452.      * @param string|UserRoles|UserPermission $attribute
  453.      * @param mixed $subject
  454.      */
  455.     public function denyAccessUnlessGranted($attribute, $subject = null, string $message = 'Access Denied.'): void
  456.     {
  457.             $this->denyAccessUnlessGrantedCheck($attribute, $subject, $message);
  458.     }
  460.     protected function denyAccessUnlessGrantedCheck($attribute, $subject = null, string $message = 'Access Denied.'): void
  461.     {
  462.         if (!$this->isGranted($attribute, $subject)) {
  463.             $exception = $this->createAccessDeniedException($message);
  464.             $exception->setAttributes([$attribute]);
  465.             $exception->setSubject($subject);
  467.             throw $exception;
  468.         }
  469.     }
  471.     public function getAdmin(): ?User
  472.     {
  473.         $user = $this->getUser();
  475.         if (null === $user) {
  476.             return null;
  477.         }
  479.         if (!($user instanceof User)) {
  480.             throw new AuthenticationException('User must be of User type');
  481.         }
  483.         return $user;
  484.     }
  486.     /**
  487.      * @param string|UserRoles|UserPermission $attribute
  488.      * @param mixed $subject
  489.      */
  490.     protected function isGranted($attribute, $subject = null): bool
  491.     {
  492.         return $this->getControllerUtil()->getAuthorizationChecker()->isGranted($attribute, $subject);
  493.     }
  495. }