KernelEvent.php in Zircon Profile 8

Namespace

Symfony\Component\HttpKernel\Event

File

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

<?php

/*
 * This file is part of the Symfony package.
 *
 * (c) Fabien Potencier <[e-mail]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
namespace Symfony\Component\HttpKernel\Event;

use Symfony\Component\HttpKernel\HttpKernelInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\EventDispatcher\Event;

/**
 * Base class for events thrown in the HttpKernel component.
 *
 * @author Bernhard Schussek <[e-mail]>
 */
class KernelEvent extends Event {

  /**
   * The kernel in which this event was thrown.
   *
   * @var HttpKernelInterface
   */
  private $kernel;

  /**
   * The request the kernel is currently processing.
   *
   * @var Request
   */
  private $request;

  /**
   * The request type the kernel is currently processing.  One of
   * HttpKernelInterface::MASTER_REQUEST and HttpKernelInterface::SUB_REQUEST.
   *
   * @var int
   */
  private $requestType;
  public function __construct(HttpKernelInterface $kernel, Request $request, $requestType) {
    $this->kernel = $kernel;
    $this->request = $request;
    $this->requestType = $requestType;
  }

  /**
   * Returns the kernel in which this event was thrown.
   *
   * @return HttpKernelInterface
   */
  public function getKernel() {
    return $this->kernel;
  }

  /**
   * Returns the request the kernel is currently processing.
   *
   * @return Request
   */
  public function getRequest() {
    return $this->request;
  }

  /**
   * Returns the request type the kernel is currently processing.
   *
   * @return int One of HttpKernelInterface::MASTER_REQUEST and
   *             HttpKernelInterface::SUB_REQUEST
   */
  public function getRequestType() {
    return $this->requestType;
  }

  /**
   * Checks if this is a master request.
   *
   * @return bool True if the request is a master request
   */
  public function isMasterRequest() {
    return HttpKernelInterface::MASTER_REQUEST === $this->requestType;
  }

}

Classes

Name	Description
KernelEvent	Base class for events thrown in the HttpKernel component.