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

MagicFunctionProvider

class MagicFunctionProvider implements EventSubscriberInterface, ProviderInterface

This class manages the loading of API's using strict file+function naming conventions.

Methods

static array
getSubscribedEvents()

No description

__construct()

No description

onApiResolve(ResolveEvent $event)

No description

array
invoke(array $apiRequest)

No description

array
getEntityNames(int $version)

No description

array
getActionNames(int $version, string $entity)

No description

array
resolve(array $apiRequest)

Look up the implementation for a given API request.

string
getFunctionName(string $entity, string $action, int $version)

Determine the function name for a given API request.

loadEntity(string $entity, int $version)

Load/require all files related to an entity.

Details

at line 42
static array getSubscribedEvents()

Return Value

array

at line 57
__construct()

at line 65
onApiResolve(ResolveEvent $event)

Parameters

ResolveEvent $event API resolution event.

at line 81
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 111
array getEntityNames(int $version)

Parameters

int $version API version.

Return Value

array

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

Parameters

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

Return Value

array

at line 192
protected array resolve(array $apiRequest)

Look up the implementation for a given API request.

Parameters

array $apiRequest Array with keys: - entity: string, required. - action: string, required. - params: array. - version: scalar, required.

Return Value

array Array with keys: - function: callback (mixed) - is_generic: boolean

at line 263
protected string getFunctionName(string $entity, string $action, int $version)

Determine the function name for a given API request.

Parameters

string $entity API entity name.
string $action API action name.
int $version API version.

Return Value

string

at line 279
protected loadEntity(string $entity, int $version)

Load/require all files related to an entity.

This should not normally be called because it's does a file-system scan; it's only appropriate when introspection is really required (eg for "getActions").

Parameters

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