1. class
  2. Civi
  3. \
  4. API
  5. \
  6. Exception
  7. \
  8. UnauthorizedException

UnauthorizedException

class UnauthorizedException extends API_Exception

Class UnauthorizedException

Constants

UNAUTHORIZED

NOT_IMPLEMENTED

Methods

__construct(string $message, array $extraParams = [], Exception $previous = NULL)

No description

string
__toString()

Custom string representation of object.

from API_Exception
array
getExtraParams()

Get extra parameters.

from API_Exception
array
getErrorCodes()

Get error codes.

from API_Exception

Details

at line 22
__construct(string $message, array $extraParams = [], Exception $previous = NULL)

Parameters

string $message The human friendly error message.
array $extraParams Extra params to return. eg an extra array of ids. It is not mandatory, but can help the computer using the api. Keep in mind the api consumer isn't to be trusted. eg. the database password is NOT a good extra data.
Exception $previous A previous exception which caused this new exception.

in API_Exception at line 57
string __toString()

Custom string representation of object.

Return Value

string

in API_Exception at line 66
array getExtraParams()

Get extra parameters.

Return Value

array

in API_Exception at line 75
array getErrorCodes()

Get error codes.

Return Value

array