Версия: 3.x
Класс AbstractException
Граф наследования:AbstractException:
Exception Exception

Подробное описание

Базовый класс исключений для внешних API. Рекомендуется использовать приоритетно коды ошибок, расположенные в классе Exception. Только в случае весомой необходимости создавать наследников данного класса и собственные коды ошибок.

Открытые члены

 __construct ($message= '', $code_string= '', Exception $previous=null, $extra_info= '')
 
 getCodeString ()
 
 addExtraApiData ($key, $value)
 
 getApiError ()
 
 getInfo ($lang)
 
- Открытые члены унаследованные от Exception
 __construct ($message= '', $code=0, Exception $previous=null, $extra_info= '')
 
 getExtraInfo ()
 

Поля данных

const INTERNAL_ERROR_ID = 'inside'
 
 $code_string
 

Защищенные члены

 getComment ($comment, $lang)
 
 prepareDocComment ($text, $lang)
 

Дополнительные унаследованные члены

- Защищенные данные унаследованные от Exception
 $extra_info = ''
 

Конструктор(ы)

__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- значение
Возвращает
void
getApiError ( )

Возвращает полную информацию об ошибке для её передачи в ответ на вызов метода API

Возвращает
array
getCodeString ( )

Возвращает строковый идентификатор ошибки

Возвращает
string
getComment (   $comment,
  $lang 
)
protected

Возвращает описание метода API, исходя из PHPDoc описания

Аргументы
string$commentполный PHPDoc комментарий к функции process...
Возвращает
string | null
getInfo (   $lang)

Возвращает информацию о кодах ошибок, которые обрабатывает текущий класс исключений

Возвращает
array
prepareDocComment (   $text,
  $lang 
)
protected

Форматирует комментарий, полученный из PHPDoc

Аргументы
string$text- комментарий
Возвращает
string

Поля

$code_string
const INTERNAL_ERROR_ID = 'inside'