core_ai\error\base Class Reference

Inheritance diagram for core_ai\error\base:

Public Member Functions
	__construct (private int readonly int $errorcode, private string readonly string $errormessage, private string readonly string $errorsource="upstream",)
	Constructor for the error handler.
	get_error ()
	Get the error name.
	get_error_details ()
	Get the error data and return its details.
	get_errorcode ()
	Get the error code.
	get_errormessage ()
	Get the error message.
	get_errorsource ()
	Get the error message.

Protected Member Functions
	get_errorcode_description (int $errorcode)
	Get the error code description.
	get_message_error_type ()
	Get the message error type based on the debug configuration.

Protected Attributes
int int	$messagetype
	The type of error message.
string const	ERROR_SOURCE_UPSTREAM = "upstream"
	Error code for upstream errors.
int const	ERROR_TYPE_DETAILED = 1
	Error type for more.
int const	ERROR_TYPE_MINIMAL = 0
	Error type for less.

Constructor & Destructor Documentation

__construct()

core_ai\error\base::__construct	(	private int readonly int	$errorcode,
		private string readonly string	$errormessage,
		private string readonly string	$errorsource = "upstream" )

Constructor for the error handler.

Parameters

int	$errorcode	The error code.
string	$errormessage	The error message.
string	$errorsource	The error source.

Parameters

$errorcode	The error code.
$errormessage	The error message.
$errorsource	The error source.

Member Function Documentation

get_error()

core_ai\error\base::get_error

(

)

Get the error name.

Return values

string

The error source.

Reimplemented in core_ai\error\ratelimit.

get_error_details()

core_ai\error\base::get_error_details

(

)

Get the error data and return its details.

Return values

array

The error details.

get_errorcode()

core_ai\error\base::get_errorcode

(

)

Get the error code.

Return values

int	The error code.

get_errorcode_description()

core_ai\error\base::get_errorcode_description ( int $errorcode )

protected

Get the error code description.

Parameters

int

$errorcode

The error code.

Return values

string

The error code description.

get_errormessage()

core_ai\error\base::get_errormessage

(

)

Get the error message.

Return values

string

The error message.

Reimplemented in core_ai\error\notfound, core_ai\error\ratelimit, core_ai\error\serverfailure, and core_ai\error\unauthorized.

get_errorsource()

core_ai\error\base::get_errorsource

(

)

Get the error message.

Return values

string

The error message.

get_message_error_type()

core_ai\error\base::get_message_error_type ( )

protected

Get the message error type based on the debug configuration.

Return values

int	The message error type.

Member Data Documentation

ERROR_TYPE_DETAILED

int const core_ai\error\base::ERROR_TYPE_DETAILED = 1

protected

Error type for more.

It means the LMS debug level is >= "ALL".

ERROR_TYPE_MINIMAL

int const core_ai\error\base::ERROR_TYPE_MINIMAL = 0

protected

Error type for less.

It means the LMS debug level is < "ALL"

---

The documentation for this class was generated from the following file:

• ai/classes/error/base.php