GetResponseForControllerResultEvent.php in Zircon Profile 8

Namespace

Symfony\Component\HttpKernel\Event

File

vendor/symfony/http-kernel/Event/GetResponseForControllerResultEvent.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;

/**
 * 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 <[e-mail]>
 */
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
   */
  public function getControllerResult() {
    return $this->controllerResult;
  }

  /**
   * Assigns the return value of the controller.
   *
   * @param mixed $controllerResult The controller return value
   */
  public function setControllerResult($controllerResult) {
    $this->controllerResult = $controllerResult;
  }

}

Classes

Name	Description
GetResponseForControllerResultEvent	Allows to create a response for the return value of a controller.