1. class
  2. Civi
  3. \
  4. API
  5. \
  6. Event
  7. \
  8. ExceptionEvent

ExceptionEvent

class ExceptionEvent extends Event

Class ExceptionEvent

Properties

protected Kernel $apiKernel from Event
protected ProviderInterface $apiProvider from Event
protected array $apiRequest from Event

Methods

__construct(Exception $exception, ProviderInterface $apiProvider, array $apiRequest, Kernel $apiKernel)

No description

Kernel
getApiKernel()

Get api kernel.

from Event
ProviderInterface
getApiProvider()

No description

from Event
array
getApiRequest()

No description

from Event
string
getApiRequestSig()

Create a brief string identifying the entity/action. Useful for pithy matching/switching.

from Event
Exception
getException()

No description

Details

at line 51
__construct(Exception $exception, ProviderInterface $apiProvider, array $apiRequest, Kernel $apiKernel)

Parameters

Exception $exception The exception which arose while processing the API request.
ProviderInterface $apiProvider The API responsible for executing the request.
array $apiRequest The full description of the API request.
Kernel $apiKernel

in Event at line 73
Kernel getApiKernel()

Get api kernel.

Return Value

Kernel

in Event at line 80
ProviderInterface getApiProvider()

Return Value

ProviderInterface

in Event at line 87
array getApiRequest()

Return Value

array

in Event at line 100
string getApiRequestSig()

Create a brief string identifying the entity/action. Useful for pithy matching/switching.

Ex: if ($e->getApiRequestSig() === '3.contact.get') { ... }

Return Value

string Ex: '3.contact.get'

at line 59
Exception getException()

Return Value

Exception