1. class
  2. Civi
  3. \
  4. Api4
  5. \
  6. Provider
  7. \
  8. ActionObjectProvider

ActionObjectProvider

class ActionObjectProvider implements EventSubscriberInterface, ProviderInterface

Accept $apiRequests based on \Civi\API\Action

Methods

static array
getSubscribedEvents()

No description

onApiResolve(ResolveEvent $event)

No description

array
invoke(AbstractAction $action)

No description

handleChains(AbstractAction $action, Result $result)

Run each chained action once per row

array|Result|null
runChain($request, $row)

Run a chained action

resolveChainLinks(mixed $val, array $result)

Swap out variable names

array
getEntityNames(int $version)

No description

array
getActionNames(int $version, string $entity)

No description

Details

at line 45
static array getSubscribedEvents()

Return Value

array

at line 60
onApiResolve(ResolveEvent $event)

Parameters

ResolveEvent $event API resolution event.

at line 76
array invoke(AbstractAction $action)

Parameters

AbstractAction $action

Return Value

array structured response data (per civicrm_api3_create_success)

at line 95
protected handleChains(AbstractAction $action, Result $result)

Run each chained action once per row

Parameters

AbstractAction $action
Result $result

at line 113
protected array|Result|null runChain($request, $row)

Run a chained action

Parameters

$request
$row

Return Value

array|Result|null

Exceptions

API_Exception

Swap out variable names

Parameters

mixed $val
array $result

at line 144
array getEntityNames(int $version)

Parameters

int $version API version.

Return Value

array

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

Parameters

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

Return Value

array