1. class
  2. Civi
  3. \
  4. API
  5. \
  6. Subscriber
  7. \
  8. APIv3SchemaAdapter

APIv3SchemaAdapter

class APIv3SchemaAdapter implements EventSubscriberInterface

This class determines what fields are allowed for a request and validates that the fields are provided correctly.

Methods

static array
getSubscribedEvents()

No description

onApiPrepare(PrepareEvent $event)

No description

onApiPrepare_validate(Event $event)

No description

array
getDefaults($fields)

Return array of defaults for the given API (function is a wrapper on getfields).

array
getRequired($fields)

Return array of required fields for the given API (function is a wrapper on getfields).

Details

at line 42
static array getSubscribedEvents()

Return Value

array

at line 57
onApiPrepare(PrepareEvent $event)

Parameters

PrepareEvent $event API preparation event.

Exceptions

API_Exception

at line 83
onApiPrepare_validate(Event $event)

Parameters

Event $event API preparation event.

Exceptions

Exception

at line 102
array getDefaults($fields)

Return array of defaults for the given API (function is a wrapper on getfields).

Parameters

$fields

Return Value

array

at line 118
array getRequired($fields)

Return array of required fields for the given API (function is a wrapper on getfields).

Parameters

$fields

Return Value

array