ICanBoogie / Routing

lib/Route/RescueEvent.php

<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie\Routing\Route;

use ICanBoogie\Event;
use ICanBoogie\HTTP\Request;
use ICanBoogie\HTTP\Response;
use ICanBoogie\Routing\Route;

/**
 * Event class for the `ICanBoogie\Routing\RouteDispatcher::rescue` event.
 *
 * Event hooks may use this event to _rescue_ a route by providing a suitable response, or
 * replace the exception to throw if the rescue fails.
 *
 * @property \Exception $exception
 * @property-read Request $request
 * @property Response|null $response
 */
class RescueEvent extends Event

This class seems to be duplicated in your project.

{
	const TYPE = 'rescue';

	/**
	 * Reference to the exception to throw if the rescue fails.
	 *
	 * @var \Exception
	 */
	private $exception;

	/**
	 * @return \Exception
	 */
	protected function get_exception()
	{
		return $this->exception;
	}

	/**
	 * @param \Exception $exception
	 *
	 * @return \Exception
	 */
	protected function set_exception(\Exception $exception)
	{
		return $this->exception = $exception;
	}

	/**
	 * The request.
	 *
	 * @var Request
	 */
	private $request;

	/**
	 * @return Request
	 */
	protected function get_request()
	{
		return $this->request;
	}

	/**
	 * Reference to the response that rescue the route.
	 *
	 * @var Response
	 */
	private $response;

	/**
	 * @return Response|null
	 */
	protected function get_response()
	{
		return $this->response;
	}

	/**
	 * @param Response|null $response
	 */
	protected function set_response(Response $response = null)
	{
		$this->response = $response;
	}

	/**
	 * The event is constructed with the type {@link self::TYPE}.
	 *
	 * @param Route $target
	 * @param \Exception $exception Reference to the exception thrown while dispatching the route.
	 * @param Request $request
	 * @param Response|null $response
	 */
	public function __construct(Route $target, \Exception &$exception, Request $request, Response &$response = null)
	{
		$this->exception = &$exception;
		$this->request = $request;
		$this->response = &$response;

		parent::__construct($target, self::TYPE);
	}
}