ApiException
extends BackendException
in package
EBSCO API Exception class
Tags
Table of Contents
- $apiErrorDetails : array<string|int, mixed>
- Error message details returned from the API
- $tags : array<string|int, mixed>
- Tags.
- __construct() : mixed
- Constructor
- addTag() : void
- Add a tag.
- getApiDetailedErrorDescription() : string
- Known api detailed error description
- getApiError() : array<string|int, mixed>
- Get the Api Error message details.
- getApiErrorCode() : array<string|int, mixed>
- Known api error code
- getApiErrorDescription() : string
- Known api error description
- getTags() : array<string|int, mixed>
- Return all tags.
- hasTag() : bool
- Return true if the exception has the requested tag.
- isApiError() : bool
- Is this a know api error
- setApiError() : void
- Set the api error details into an array
Properties
$apiErrorDetails
Error message details returned from the API
protected
array<string|int, mixed>
$apiErrorDetails
= []
$tags
Tags.
protected
array<string|int, mixed>
$tags
= []
Methods
__construct()
Constructor
public
__construct(array<string|int, mixed> $apiErrorMessage) : mixed
Parameters
- $apiErrorMessage : array<string|int, mixed>
-
Error message
Return values
mixed —addTag()
Add a tag.
public
addTag(string $tag) : void
Parameters
- $tag : string
-
Tag name
Return values
void —getApiDetailedErrorDescription()
Known api detailed error description
public
getApiDetailedErrorDescription() : string
Return values
string —getApiError()
Get the Api Error message details.
public
getApiError() : array<string|int, mixed>
Return values
array<string|int, mixed> —getApiErrorCode()
Known api error code
public
getApiErrorCode() : array<string|int, mixed>
Return values
array<string|int, mixed> —getApiErrorDescription()
Known api error description
public
getApiErrorDescription() : string
Return values
string —getTags()
Return all tags.
public
getTags() : array<string|int, mixed>
Return values
array<string|int, mixed> —hasTag()
Return true if the exception has the requested tag.
public
hasTag(string $tag) : bool
Parameters
- $tag : string
-
Tag
Return values
bool —isApiError()
Is this a know api error
public
isApiError() : bool
Return values
bool —setApiError()
Set the api error details into an array
protected
setApiError(array<string|int, mixed> $message) : void
Parameters
- $message : array<string|int, mixed>
-
Error message