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

AdhocProvider

class AdhocProvider implements EventSubscriberInterface, ProviderInterface

An adhoc provider is useful for creating mock API implementations.

Properties

protected array $actions
protected string $entity
protected int $version

Methods

static array
getSubscribedEvents()

No description

__construct(int $version, string $entity)

No description

AdhocProvider
addAction(string $name, string $perm, mixed $callback)

Register a new API.

onApiResolve(ResolveEvent $event)

No description

onApiAuthorize(AuthorizeEvent $event)

No description

array
invoke(array $apiRequest)

No description

array
getEntityNames(int $version)

No description

array
getActionNames(int $version, string $entity)

No description

bool
matchesRequest(array $apiRequest)

No description

Details

at line 41
static array getSubscribedEvents()

Return Value

array

at line 76
__construct(int $version, string $entity)

Parameters

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

at line 92
AdhocProvider addAction(string $name, string $perm, mixed $callback)

Register a new API.

Parameters

string $name Action name.
string $perm Permissions required for invoking the action.
mixed $callback The function which executes the API.

Return Value

AdhocProvider

at line 104
onApiResolve(ResolveEvent $event)

Parameters

ResolveEvent $event API resolution event.

at line 117
onApiAuthorize(AuthorizeEvent $event)

Parameters

AuthorizeEvent $event API authorization event.

at line 130
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)

at line 139
array getEntityNames(int $version)

Parameters

int $version API version.

Return Value

array

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

Parameters

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

Return Value

array

at line 164
bool matchesRequest(array $apiRequest)

Parameters

array $apiRequest The full description of the API request.

Return Value

bool