CRM_Core_Exception

class CRM_Core_Exception extends PEAR_Exception

Base class for exceptions generated by CiviCRM.

This Exception returns more information than the default one. We are using it from the form layer to allow redirects to occur without having redirects in the BAO

Methods

__construct(string $message, int $error_code = 0, array $errorData = [], null $previous = NULL)

Class constructor.

string
__toString()

Custom string representation of object.

mixed
getErrorCode()

Get error code.

array
getErrorData()

Return specific error information.

Details

at line 51
__construct(string $message, int $error_code = 0, array $errorData = [], null $previous = NULL)

Class constructor.

Parameters

string $message
int $error_code
array $errorData
null $previous

at line 61
string __toString()

Custom string representation of object.

Return Value

string

at line 70
mixed getErrorCode()

Get error code.

Return Value

mixed

at line 89
array getErrorData()

Return specific error information.

(Can be used for more detailed error messages or translation.)

This method may be overridden in child exception classes in order to add functionality not present in PEAR_Exception and is a placeholder to define API

The returned array must be an associative array of parameter => value like so:

array('name' => $name, 'context' => array(...))

Return Value

array