Class MissingOptionException

Exception raised with suggestions

Namespace: Cake\Console\Exception

Properties summary

  • $_attributes protected
    array

    Array of attributes that are passed in from the constructor, and made available in the view when a development error is displayed.

  • $_defaultCode protected
    int

    Default exception code

  • $_messageTemplate protected
    string

    Template string that has attributes sprintf()'ed into it.

  • $_responseHeaders protected
    array|null

    Array of headers to be passed to Cake\Http\Response::header()

  • $requested protected
    string

    The requested thing that was not found.

  • $suggestions protected
    string[]

    The valid suggestions.

Method Summary

Method Detail

__construct() public 

__construct(string $message, string $requested, array $suggestions, ?int $code, ?\Throwable $previous)

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(mixed $needle, mixed $haystack)

Find the best match for requested in suggestions

Parameters

string $needle

Unknown option name trying to be used.

string[] $haystack

Suggestions to look through.

Returns

string

The best match

getAttributes() public 

getAttributes()

Get the passed in attributes

Returns

array

getCode() public 

getCode()

Gets the Exception code.

getFullMessage() public 

getFullMessage()

Get the message with suggestions

Returns

string

responseHeader() public 

responseHeader(mixed $header, mixed $value)

Get/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

Property Detail

$_attributes protected

Array of attributes that are passed in from the constructor, and made available in the view when a development error is displayed.

Type

array

$_defaultCode protected

Default exception code

Type

int

$_messageTemplate protected

Template string that has attributes sprintf()'ed into it.

Type

string

$_responseHeaders protected

Array of headers to be passed to Cake\Http\Response::header()

Type

array|null

$requested protected

The requested thing that was not found.

Type

string

$suggestions protected

The valid suggestions.

Type

string[]

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.0/class-Cake.Console.Exception.MissingOptionException.html