Версия: 6.x
Базовый класс исключений для внешних API. Рекомендуется использовать приоритетно коды ошибок, расположенные в классе Exception. Только в случае весомой необходимости создавать наследников данного класса и собственные коды ошибок.
Открытые члены | |
| __construct ($message= '', $code_string= '', Exception $previous=null, $extra_info= '') | |
| getCodeString () | |
| addExtraApiData ($key, $value) | |
| getApiError () | |
| getInfo ($lang) | |
 Открытые члены унаследованные от Exception | |
| __construct ($message= '', $code=0, Throwable $previous=null, $extra_info= '', array $extra_data=[]) | |
| getExtraInfo () | |
| getExtraData (string $key, $default=null) | |
Поля данных | |
| const | INTERNAL_ERROR_ID = 'inside' |
| $code_string | |
Защищенные члены | |
| getComment ($comment, $lang) | |
| prepareDocComment ($text, $lang) | |
Дополнительные унаследованные члены | |
| Защищенные данные унаследованные от Exception | |
| $extra_info = '' | |
| $extra_data | |
| __construct | ( | $message = '', |
|
$code_string = '', |
|||
| Exception | $previous = null, |
||
$extra_info = '' |
|||
| ) |
Конструктор исключения, возникшего при выполнении запроса к API
| string | $message | - Пояснение к ошибке |
| string | $code_string | - Строковый идентификатор ошибки (вместо числового, для исключения конфликтов. Любой сторонний модуль может привносить свои ошибки) |
| Exception | $previous | - Предыдущее исключение в цепочке |
| string | $extra_info | - Дополнительная информация для отображения |
| addExtraApiData | ( | $key, | |
| $value | |||
| ) |
Добавляет произвольную пару ключ -> значение в сведения об ошибке
| string | $key | - ключ |
| mixed | $value | - значение |
| getApiError | ( | ) |
Возвращает полную информацию об ошибке для её передачи в ответ на вызов метода API
| getCodeString | ( | ) |
Возвращает строковый идентификатор ошибки
|
protected |
Возвращает описание метода API, исходя из PHPDoc описания
| string | $comment | полный PHPDoc комментарий к функции process... |
| getInfo | ( | $lang | ) |
Возвращает информацию о кодах ошибок, которые обрабатывает текущий класс исключений
|
protected |
Форматирует комментарий, полученный из PHPDoc
| string | $text | - комментарий |
| $code_string |
| const INTERNAL_ERROR_ID = 'inside' |