Class MissingOptionException
Exception raised with suggestions
Property Summary
-
$_attributes protected
arrayArray of attributes that are passed in from the constructor, and made available in the view when a development error is displayed.
-
$_defaultCode protected
intDefault exception code
-
$_messageTemplate protected
stringTemplate string that has attributes sprintf()'ed into it.
-
$_responseHeaders protected
array|nullArray of headers to be passed to Cake\Http\Response::header()
-
$requested protected
stringThe requested thing that was not found.
-
$suggestions protected
string[]The valid suggestions.
Method Summary
-
__construct() public
Constructor.
-
findClosestItem() protected
Find the best match for requested in suggestions
-
getAttributes() public
Get the passed in attributes
-
getCode() public @method
Gets the Exception code.
-
getFullMessage() public
Get the message with suggestions
-
responseHeader() public deprecated
Get/set the response header to be used
Method Detail
__construct() ¶ public
__construct(string $message, string $requested = '', string[] $suggestions = [], int|null $code = null, Throwable|null $previous = null)Constructor.
Parameters
-
string$message The string message.
-
string$requested optional The requested value.
-
string[]$suggestions optional The list of potential values that were valid.
-
int|null$code optional The exception code if relevant.
-
Throwable|null$previous optional the previous exception.
findClosestItem() ¶ protected
findClosestItem(string $needle, string[] $haystack): stringFind the best match for requested in suggestions
Parameters
-
string$needle Unknown option name trying to be used.
-
string[]$haystack Suggestions to look through.
Returns
stringresponseHeader() ¶ public
responseHeader(string|array|null $header = null, string|null $value = null): array|nullGet/set the response header to be used
See also Cake\Http\Response::withHeader()
Parameters
-
string|array|null$header optional A single header string or an associative array of "header name" => "header value"
-
string|null$value optional The header value.
Returns
array|null