Class ServiceUnavailableException

Represents an HTTP 503 error.

Namespace: Cake\Http\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()

Method Summary

Method Detail

__construct() public 

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

Constructor

Parameters

string|null $message optional

If no message is given 'Service Unavailable' will be the message

int|null $code optional

Status code, defaults to 503

\Throwable|null $previous optional

The previous exception.

getAttributes() public 

getAttributes()

Get the passed in attributes

Returns

array

getCode() public 

getCode()

Gets the Exception code.

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

© 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.1/class-Cake.Http.Exception.ServiceUnavailableException.html