Documentation

ReflectionProvider
in package
implements EventSubscriberInterface, ProviderInterface

This class defines operations for inspecting the API's metadata.

Table of Contents

Interfaces

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

Properties

$actions  : array<string|int, mixed>
List of all entities and their supported actions
$apiKernel  : Kernel

Methods

__construct()  : mixed
getActionNames()  : array<string|int, mixed>
getEntityNames()  : array<string|int, mixed>
getSubscribedEvents()  : array<string|int, mixed>
invoke()  : array<string|int, mixed>
onApiAuthorize()  : mixed
onApiResolve()  : mixed

Properties

$actions

List of all entities and their supported actions

private array<string|int, mixed> $actions

array(string $entityName => string[] $actionNames).

Methods

getActionNames()

public getActionNames(int $version, string $entity) : array<string|int, mixed>
Parameters
$version : int
$entity : string
Tags
inheritDoc
Return values
array<string|int, mixed>

getEntityNames()

public getEntityNames(int $version) : array<string|int, mixed>
Parameters
$version : int
Tags
inheritDoc
Return values
array<string|int, mixed>

getSubscribedEvents()

public static getSubscribedEvents() : array<string|int, mixed>
Return values
array<string|int, mixed>

invoke()

public invoke(array<string|int, mixed> $apiRequest) : array<string|int, mixed>
Parameters
$apiRequest : array<string|int, mixed>
Tags
inheritDoc
throws
CRM_Core_Exception
Return values
array<string|int, mixed>

        
On this page

Search results