ICanBoogie\HTTP\ForceRedirect

Complexity

Total Complexity

3

Size/Duplication

Total Lines	41
Duplicated Lines	73.17 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	get_location()	4	4	1
A	__construct()	6	6	1
A	format_message()	0	4	1

<?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 ]);
	}
}