ProviderInterface
in
An API "provider" provides a means to execute API requests.
Table of Contents
Methods
- getActionNames() : array<string|int, string>
- getEntityNames() : array<string|int, string>
- invoke() : array<string|int, mixed>
Methods
getActionNames()
public
getActionNames(int $version, string $entity) : array<string|int, string>
Parameters
- $version : int
-
API version.
- $entity : string
-
API entity.
Return values
array<string|int, string>getEntityNames()
public
getEntityNames(int $version) : array<string|int, string>
Parameters
- $version : int
-
API version.
Return values
array<string|int, string>invoke()
public
invoke(array<string|int, mixed> $apiRequest) : array<string|int, mixed>
Parameters
- $apiRequest : array<string|int, mixed>
-
The full description of the API request.
Tags
Return values
array<string|int, mixed> —structured response data (per civicrm_api3_create_success)