1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 <?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\HTTP;
use ICanBoogie\Accessor\AccessorTrait;
/**
* Exception thrown to force the redirect of the response.
*
* @property-read string $location The location of the redirect.
*/
class ForceRedirect extends \Exception implements Exception
{
use AccessorTrait;
/**
* @var string
*/
private $location;
/**
* @return string
*/
protected function get_location()
{
return $this->location;
}
/**
* @param string $location
* @param int $code
* @param \Exception|null $previous
*/
public function __construct($location, $code = Status::FOUND, \Exception $previous = null)
{
$this->location = $location;
parent::__construct($this->format_message($location), $code, $previous);
}
/**
* Formats exception message.
*
* @param string $location
*
* @return string
*/
protected function format_message($location)
{
return \ICanBoogie\format("Location: %location", [ 'location' => $location ]);
}
}