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

Event

class Event extends Event

Class Event

Properties

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

Methods

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

No description

Kernel
getApiKernel()

Get api kernel.

ProviderInterface
getApiProvider()

No description

array
getApiRequest()

No description

string
getApiRequestSig()

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

Details

at line 62
__construct(ProviderInterface $apiProvider, array $apiRequest, Kernel $apiKernel)

Parameters

ProviderInterface $apiProvider The API responsible for executing the request.
array $apiRequest The full description of the API request.
Kernel $apiKernel

at line 73
Kernel getApiKernel()

Get api kernel.

Return Value

Kernel

at line 80
ProviderInterface getApiProvider()

Return Value

ProviderInterface

at line 87
array getApiRequest()

Return Value

array

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'