annotate vendor/symfony/http-kernel/Event/GetResponseForControllerResultEvent.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\HttpKernel\Event;
Chris@0 13
Chris@17 14 use Symfony\Component\HttpFoundation\Request;
Chris@0 15 use Symfony\Component\HttpKernel\HttpKernelInterface;
Chris@0 16
Chris@0 17 /**
Chris@0 18 * Allows to create a response for the return value of a controller.
Chris@0 19 *
Chris@0 20 * Call setResponse() to set the response that will be returned for the
Chris@0 21 * current request. The propagation of this event is stopped as soon as a
Chris@0 22 * response is set.
Chris@0 23 *
Chris@0 24 * @author Bernhard Schussek <bschussek@gmail.com>
Chris@0 25 */
Chris@0 26 class GetResponseForControllerResultEvent extends GetResponseEvent
Chris@0 27 {
Chris@0 28 /**
Chris@0 29 * The return value of the controller.
Chris@0 30 *
Chris@0 31 * @var mixed
Chris@0 32 */
Chris@0 33 private $controllerResult;
Chris@0 34
Chris@0 35 public function __construct(HttpKernelInterface $kernel, Request $request, $requestType, $controllerResult)
Chris@0 36 {
Chris@0 37 parent::__construct($kernel, $request, $requestType);
Chris@0 38
Chris@0 39 $this->controllerResult = $controllerResult;
Chris@0 40 }
Chris@0 41
Chris@0 42 /**
Chris@0 43 * Returns the return value of the controller.
Chris@0 44 *
Chris@0 45 * @return mixed The controller return value
Chris@0 46 */
Chris@0 47 public function getControllerResult()
Chris@0 48 {
Chris@0 49 return $this->controllerResult;
Chris@0 50 }
Chris@0 51
Chris@0 52 /**
Chris@0 53 * Assigns the return value of the controller.
Chris@0 54 *
Chris@0 55 * @param mixed $controllerResult The controller return value
Chris@0 56 */
Chris@0 57 public function setControllerResult($controllerResult)
Chris@0 58 {
Chris@0 59 $this->controllerResult = $controllerResult;
Chris@0 60 }
Chris@0 61 }