vendor/symfony/http-kernel/Event/KernelEvent.php line 88

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\Component\HttpKernel\Event;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\HttpKernel\HttpKernelInterface;
  16. use Symfony\Contracts\EventDispatcher\Event;
  18. /**
  19.  * Base class for events thrown in the HttpKernel component.
  20.  *
  21.  * @author Bernhard Schussek <bschussek@gmail.com>
  22.  */
  23. class KernelEvent extends Event
  24. {
  25.     private $kernel;
  26.     private $request;
  27.     private $requestType;
  29.     /**
  30.      * @param int $requestType The request type the kernel is currently processing; one of
  31.      *                         HttpKernelInterface::MAIN_REQUEST or HttpKernelInterface::SUB_REQUEST
  32.      */
  33.     public function __construct(HttpKernelInterface $kernel, Request $request, ?int $requestType)
  34.     {
  35.         $this->kernel = $kernel;
  36.         $this->request = $request;
  37.         $this->requestType = $requestType;
  38.     }
  40.     /**
  41.      * Returns the kernel in which this event was thrown.
  42.      *
  43.      * @return HttpKernelInterface
  44.      */
  45.     public function getKernel()
  46.     {
  47.         return $this->kernel;
  48.     }
  50.     /**
  51.      * Returns the request the kernel is currently processing.
  52.      *
  53.      * @return Request
  54.      */
  55.     public function getRequest()
  56.     {
  57.         return $this->request;
  58.     }
  60.     /**
  61.      * Returns the request type the kernel is currently processing.
  62.      *
  63.      * @return int One of HttpKernelInterface::MAIN_REQUEST and
  64.      *             HttpKernelInterface::SUB_REQUEST
  65.      */
  66.     public function getRequestType()
  67.     {
  68.         return $this->requestType;
  69.     }
  71.     /**
  72.      * Checks if this is the main request.
  73.      */
  74.     public function isMainRequest(): bool
  75.     {
  76.         return HttpKernelInterface::MAIN_REQUEST === $this->requestType;
  77.     }
  79.     /**
  80.      * Checks if this is a master request.
  81.      *
  82.      * @return bool
  83.      *
  84.      * @deprecated since symfony/http-kernel 5.3, use isMainRequest() instead
  85.      */
  86.     public function isMasterRequest()
  87.     {
  88.         trigger_deprecation('symfony/http-kernel', '5.3', '"%s()" is deprecated, use "isMainRequest()" instead.', __METHOD__);
  90.         return $this->isMainRequest();
  91.     }
  92. }