<?php

declare(strict_types=1);

namespace SimpleSAML\Error;

use SimpleSAML\Utils;

/**

* Exception which will show a 404 Not Found error page.

*

* This exception can be thrown from within a module page handler. The user will then be shown a 404 Not Found error

* page.

*

* @package SimpleSAMLphp

*/

class NotFound extends Error

{

/**

* Create a new NotFound error

*

* @param string $reason Optional description of why the given page could not be found.

* @throws \SimpleSAML\Error\CriticalConfigurationError

* @throws \Exception

*/

public function __construct(

private ?string $reason = null,

) {

$httpUtils = new Utils\HTTP();

$url = $httpUtils->getSelfURL();

if ($reason === null) {

parent::__construct([ErrorCodes::NOTFOUND, '%URL%' => $url], null, 404);

$this->message = "The requested page '$url' could not be found.";

} else {

parent::__construct([ErrorCodes::NOTFOUNDREASON, '%URL%' => $url, '%REASON%' => $reason], null, 404);

$this->message = "The requested page '$url' could not be found. " . $reason;

}

}

/**

* Retrieve the reason why the given page could not be found.

*

* @return string|null The reason why the page could not be found.

*/

public function getReason(): ?string

{

return $this->reason;

}

/**

* NotFound exceptions don't need to display a backtrace, as they are very simple and the trace is usually trivial,

* so just log the message without any backtrace at all.

*

* @param bool $anonymize Whether to anonymize the trace or not.

*

* @return string[]

*/

public function format(bool $anonymize = false): array

{

return [

$this->getClass() . ': ' . $this->getMessage(),

];

}

}