Класс StopException
Класс исключений для остановки задач в консоли
См.: \Cake\Console\Shell::_stop()
См.: \Cake\Console\Shell::error()
См.: \Cake\Command\BaseCommand::abort()
Краткое описание свойств
- $_attributes protected
arrayМассив атрибутов, переданных из конструктора, доступных в представлении при отображении ошибки разработки.
- $_defaultCode protected
intКод исключения по умолчанию
- $_messageTemplate protected
stringШаблон строки, в который подставляются атрибуты с помощью sprintf().
- $_responseHeaders protected
array|nullМассив заголовков, передаваемых в Cake\Http\Response::header()
Краткое описание методов
-
__construct() public
Конструктор.
-
getAttributes() public
Получить переданные атрибуты
-
getCode() public @method
Получить код исключения.
-
responseHeader() public deprecated
Получить/установить используемый заголовок ответа
Подробное описание методов
__construct() public
__construct(string|array $message = '', int|null $code = null, Throwable|null $previous = null)
Конструктор.
Позволяет создавать исключения, которые обрабатываются как ошибки фреймворка и отключаются при выключенном режиме отладки.
Параметры
-
string|array$message optional Строка сообщения об ошибке или массив атрибутов, доступных в представлении, и подставляемых в Exception::$_messageTemplate с помощью sprintf().
-
int|null$code optional Код ошибки
-
Throwable|null$previous optional предыдущее исключение.
getAttributes() public
getAttributes(): array
Получить переданные атрибуты
Возвращает
arraygetCode() public @method
getCode(): int
Получить код исключения.
Возвращает
intresponseHeader() public
responseHeader(string|array|null $header = null, string|null $value = null): array|null
Получить/установить используемый заголовок ответа
См. также Cake\Http\Response::withHeader()
Параметры
-
string|array|null$header optional Строка одного заголовка или ассоциативный массив "имя заголовка" => "значение заголовка"
-
string|null$value optional Значение заголовка.
Возвращает
array|nullПодробное описание свойств
$_attributes protected
Массив атрибутов, переданных из конструктора, доступных в представлении при отображении ошибки разработки.
Тип
array$_defaultCode protected
Код исключения по умолчанию
Тип
int$_messageTemplate protected
Шаблон строки, в который подставляются атрибуты с помощью sprintf().
Тип
string$_responseHeaders protected
Массив заголовков, передаваемых в Cake\Http\Response::header()
Тип
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.2/class-Cake.Console.Exception.StopException.html
