Bitrix-D7  20.0.0
Класс Error
Граф наследования:Error:
Error EntityError Error Error Warning Message FieldError

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

 __construct ($message, $code=0, $customData=null)
 Creates a new Error. Подробнее...
 
 getCode ()
 Returns the code of the error. Подробнее...
 
 getMessage ()
 Returns the message of the error. Подробнее...
 
 getCustomData ()
 
 __toString ()
 
 jsonSerialize ()
 Specify data which should be serialized to JSON http://php.net/manual/en/jsonserializable.jsonserialize.php. Подробнее...
 

Защищенные данные

 $code
 
 $message
 
 $customData
 

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

См. определение в файле main/lib/error.php строка 11

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

◆ __construct()

__construct (   $message,
  $code = 0,
  $customData = null 
)

Creates a new Error.

Аргументы
string$messageMessage of the error.
int | string$codeCode of the error.
mixed | null$customDataData typically of key/value pairs that provide additional user-defined information about the error.

Переопределяется в Error.

См. определение в файле main/lib/error.php строка 31

32  {
33  $this->message = $message;
34  $this->code = $code;
35  $this->customData = $customData;
36  }

Методы

◆ __toString()

__toString ( )

См. определение в файле main/lib/error.php строка 64

65  {
66  return $this->getMessage();
67  }

◆ getCode()

getCode ( )

Returns the code of the error.

Возвращает
int|string

См. определение в файле main/lib/error.php строка 42

43  {
44  return $this->code;
45  }

◆ getCustomData()

getCustomData ( )
Возвращает
mixed|null

См. определение в файле main/lib/error.php строка 59

60  {
61  return $this->customData;
62  }

◆ getMessage()

getMessage ( )

Returns the message of the error.

Возвращает
string

См. определение в файле main/lib/error.php строка 51

52  {
53  return $this->message;
54  }

◆ jsonSerialize()

jsonSerialize ( )

Specify data which should be serialized to JSON http://php.net/manual/en/jsonserializable.jsonserialize.php.

Возвращает
mixed data which can be serialized by json_encode, which is a value of any type other than a resource.
Начиная с
5.4.0

См. определение в файле main/lib/error.php строка 76

77  {
78  return [
79  'message' => $this->getMessage(),
80  'code' => $this->getCode(),
81  'customData' => $this->getCustomData(),
82  ];
83  }

Поля

◆ $code

$code
protected

См. определение в файле main/lib/error.php строка 14

◆ $customData

$customData
protected

См. определение в файле main/lib/error.php строка 21

◆ $message

$message
protected

См. определение в файле main/lib/error.php строка 17


Объявления и описания членов класса находятся в файле:
Bitrix\Main\Error\getCustomData
getCustomData()
Definition: main/lib/error.php:59
Bitrix\Main\Error\getCode
getCode()
Returns the code of the error.
Definition: main/lib/error.php:42
Bitrix\Main\Error\$code
$code
Definition: main/lib/error.php:14
Bitrix\Main\Error\getMessage
getMessage()
Returns the message of the error.
Definition: main/lib/error.php:51
Bitrix\Main\Error\$customData
$customData
Definition: main/lib/error.php:21
Bitrix\Main\Error\$message
$message
Definition: main/lib/error.php:17