Class: SmartException

Extends

Known inheritances

Authors

Package

Source code

 

Constants
ERR_CODE_CONFIG_ERROR public	Constant for the error code "config_error".
ERR_CODE_FILE_WRITE_ERROR public	Constant for the error code "file_write_error".
ERR_CODE_INVALID_CONTENT_TYPE public	Constant for the error code "invalid_content_type".
ERR_CODE_INVALID_REQUEST_DATA public	Constant for the error code "invalid_request_data".
ERR_CODE_JSON_PARSE_ERROR public	Constant for the error code "json_parse_error".
ERR_CODE_MISSING_REQUEST_DATA public	Constant for the error code "missing_request_data".
ERR_CODE_NOT_FOUND public	Constant for the error code "not_found".
ERR_CODE_PATH_ACCESS_ERROR public	Constant for the error code "path_access_error".
ERR_CODE_SYSTEM_ERROR public	Constant for the error code "system_error".
ERR_CODE_XML_PARSE_ERROR public	Constant for the error code "xml_parse_error".

Properties
$error_code protected	Internal variable for storing the error.
$error_details protected	Internal variable for storing the error details.
$error_element protected	Internal variable for storing the error element.
$technical_info protected	Internal variable for storing the additional technical information.

Methods
__construct() public	Constructor.
getErrorCode() public	Returns the string error code of the exception.
getErrorDetails() public	Returns the error details of the exception.
getErrorElement() public	Returns the error element.
getTechnicalInfo() public	Returns the technical information for the error.
setErrorElement() public	Sets the error element.

---

Constant: SmartException::ERR_CODE_CONFIG_ERROR

Type

Authors

Source code

---

Constant: SmartException::ERR_CODE_FILE_WRITE_ERROR

Type

Authors

Source code

---

Constant: SmartException::ERR_CODE_INVALID_CONTENT_TYPE

Type

Authors

Source code

---

Constant: SmartException::ERR_CODE_INVALID_REQUEST_DATA

Type

Authors

Source code

---

Constant: SmartException::ERR_CODE_JSON_PARSE_ERROR

Type

Authors

Source code

---

Constant: SmartException::ERR_CODE_MISSING_REQUEST_DATA

Type

Authors

Source code

---

Constant: SmartException::ERR_CODE_NOT_FOUND

Type

Authors

Source code

---

Constant: SmartException::ERR_CODE_PATH_ACCESS_ERROR

Type

Authors

Source code

---

Constant: SmartException::ERR_CODE_SYSTEM_ERROR

Type

Authors

Source code

---

Constant: SmartException::ERR_CODE_XML_PARSE_ERROR

Type

Authors

Source code

---

Property: SmartException::$error_code

Type

Authors

Source code

See also

---

Property: SmartException::$error_details

Type

Authors

Source code

See also

---

Property: SmartException::$error_element

Type

Authors

Source code

See also

---

Property: SmartException::$technical_info

Type

Authors

Source code

See also

---

Method: SmartException::__construct()

Parameters

Name	Pass type	Value type	Default value	Description
$message	by value	string		Error message.
$error_code	by value	string	SmartException::ERR_CODE_SYSTEM_ERROR	Error code. Since the error texts can be localized, the unique code of the error might be important fo using in comparison.
$error_element	by value	string	""	Error element.
$error_details	by value	array	[]	The details might be useful if the message translations are provided on the client, not on the server, and the message should contain some details that may vary from case to case. In that case, the servers return the message id instead of final text and the details, the client uses the message id, gets the final translated text and substitutes the parameters through the details.
$technical_info	by value	string	""	Additional technical information. It can be used if it is a programming error and displayed only if the debug mode is active.

Authors

Source code

---

Method: SmartException::getErrorCode()

Returns

Authors

Source code

See also

---

Method: SmartException::getErrorDetails()

Returns

Authors

Source code

See also

---

Method: SmartException::getErrorElement()

Returns

Authors

Source code

See also

---

Method: SmartException::getTechnicalInfo()

Returns

Authors

Source code

See also

---

Method: SmartException::setErrorElement()

Parameters

Name	Pass type	Value type	Default value	Description
$error_element	by value	string		Error element.

Returns

Authors

Source code

See also