Class SocketException
Exception class for Socket. This exception will be thrown from Socket, Email, HttpSocket SmtpTransport, MailTransport and HttpResponse when it encounters an error.
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 {@link \Cake\Http\Response::withHeader()}
Method Summary
-
__construct() public
Constructor.
-
getAttributes() public
Get the passed in attributes
-
getCode() public @method
Gets the Exception code.
-
responseHeader() public deprecated
Get/set the response header to be used
Method Detail
__construct() ¶ public
__construct(array|string $message = '', int|null $code = null, Throwable|null $previous = null)Constructor.
Allows you to create exceptions that are treated as framework errors and disabled when debug mode is off.
Parameters
-
array|string$message optional Either the string of the error message, or an array of attributes that are made available in the view, and sprintf()'d into Exception::$_messageTemplate
-
int|null$code optional The error code
-
Throwable|null$previous optional the previous exception.
responseHeader() ¶ public
responseHeader(array|string|null $header = null, string|null $value = null): array|nullGet/set the response header to be used
See also {@link \Cake\Http\Response::withHeader()}
Parameters
-
array|string|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|nullProperty 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$_responseHeaders ¶ protected
Array of headers to be passed to {@link \Cake\Http\Response::withHeader()}
Type
array|null