1. class
  2. Civi
  3. API
  4. Subscriber
  5. 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( $event)

No description

onApiPrepare_validate( $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 41
static array getSubscribedEvents()

Return Value

array

at line 56
onApiPrepare( $event)

Parameters

$event API preparation event.

Exceptions

API_Exception

at line 82
onApiPrepare_validate( $event)

Parameters

$event API preparation event.

Exceptions

Exception

at line 98
array getDefaults($fields)

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

Parameters

$fields

Return Value

array

at line 114
array getRequired($fields)

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

Parameters

$fields

Return Value

array