1. interface
  2. Civi
  3. \
  4. API
  5. \
  6. Provider
  7. \
  8. ProviderInterface

ProviderInterface

interface ProviderInterface

An API "provider" provides a means to execute API requests.

Methods

array
invoke(array $apiRequest)

No description

array
getEntityNames(int $version)

No description

array
getActionNames(int $version, string $entity)

No description

Details

at line 43
array invoke(array $apiRequest)

Parameters

array $apiRequest The full description of the API request.

Return Value

array structured response data (per civicrm_api3_create_success)

Exceptions

API_Exception

See also

civicrm_api3_create_success

at line 50
array getEntityNames(int $version)

Parameters

int $version API version.

Return Value

array

at line 59
array getActionNames(int $version, string $entity)

Parameters

int $version API version.
string $entity API entity.

Return Value

array