Class StopException

Exception class for halting errors in console tasks

Exception implements Throwable

RuntimeException

Cake\Console\Exception\StopException

Namespace: Cake\Console\Exception
See: \Cake\Console\Shell::_stop()
See: \Cake\Console\Shell::error()
Location: Console/Exception/StopException.php

Inherited Properties

_attributes, _messageTemplate, _responseHeaders code, file, line, message

__construct( string|array $message , integer $code 500 , Exception|null $previous null )

Constructor.

Allows you to create exceptions that are treated as framework errors and disabled when debug = 0.

string|array $message: 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
integer $code optional 500: The code of the error, is also the HTTP status code for the error.
Exception|null $previous optional null: the previous exception.

Exception::__construct()

getAttributes( )

Get the passed in attributes

array

responseHeader( string|array|null $header null , string|null $value null )

Get/set the response header to be used

See also Cake\Network\Response::header()

string|array|null $header optional null: An array of header strings or a single header string - an associative array of "header name" => "header value" - an array of string headers is also accepted
string|null $value optional null: The header value.

array

© 2005–2017 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/3.3/class-Cake.Console.Exception.StopException.html