class GetResponseForControllerResultEvent

Allows to create a response for the return value of a controller

Call setResponse() to set the response that will be returned for the current request. The propagation of this event is stopped as soon as a response is set.

@author Bernhard Schussek <bschussek@gmail.com>

@api

Hierarchy

Expanded class hierarchy of GetResponseForControllerResultEvent

2 files declare their use of GetResponseForControllerResultEvent
HttpKernel.php in drupal/core/vendor/symfony/http-kernel/Symfony/Component/HttpKernel/HttpKernel.php
ViewSubscriber.php in drupal/core/lib/Drupal/Core/EventSubscriber/ViewSubscriber.php
Definition of Drupal\Core\EventSubscriber\ViewSubscriber.

File

drupal/core/vendor/symfony/http-kernel/Symfony/Component/HttpKernel/Event/GetResponseForControllerResultEvent.php, line 28

Namespace

Symfony\Component\HttpKernel\Event
View source
class GetResponseForControllerResultEvent extends GetResponseEvent {

  /**
   * The return value of the controller
   * @var mixed
   */
  private $controllerResult;
  public function __construct(HttpKernelInterface $kernel, Request $request, $requestType, $controllerResult) {
    parent::__construct($kernel, $request, $requestType);
    $this->controllerResult = $controllerResult;
  }

  /**
   * Returns the return value of the controller
   *
   * @return mixed The controller return value
   *
   * @api
   */
  public function getControllerResult() {
    return $this->controllerResult;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Event::$dispatcher private property
Event::$name private property
Event::$propagationStopped private property
Event::getDispatcher public function Returns the EventDispatcher that dispatches this Event
Event::getName public function Gets the event's name.
Event::isPropagationStopped public function Returns whether further event listeners should be triggered.
Event::setDispatcher public function Stores the EventDispatcher that dispatches this Event
Event::setName public function Sets the event's name property.
Event::stopPropagation public function Stops the propagation of the event to further event listeners.
GetResponseEvent::$response private property The response object
GetResponseEvent::getResponse public function Returns the response object
GetResponseEvent::hasResponse public function Returns whether a response was set
GetResponseEvent::setResponse public function Sets a response and stops event propagation
GetResponseForControllerResultEvent::$controllerResult private property The return value of the controller
GetResponseForControllerResultEvent::getControllerResult public function Returns the return value of the controller
GetResponseForControllerResultEvent::__construct public function Overrides KernelEvent::__construct
KernelEvent::$kernel private property The kernel in which this event was thrown
KernelEvent::$request private property The request the kernel is currently processing
KernelEvent::$requestType private property The request type the kernel is currently processing. One of HttpKernelInterface::MASTER_REQUEST and HttpKernelInterface::SUB_REQUEST
KernelEvent::getKernel public function Returns the kernel in which this event was thrown
KernelEvent::getRequest public function Returns the request the kernel is currently processing
KernelEvent::getRequestType public function Returns the request type the kernel is currently processing