Documentation

APIv3SchemaAdapter
in package
implements EventSubscriberInterface

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

Table of Contents

Interfaces

EventSubscriberInterface

Methods

getDefaults()  : array<string|int, mixed>
Return array of defaults for the given API (function is a wrapper on getfields).
getRequired()  : array<string|int, mixed>
Return array of required fields for the given API (function is a wrapper on getfields).
getSubscribedEvents()  : array<string|int, mixed>
onApiPrepare()  : mixed
onApiPrepare_validate()  : mixed

Methods

getDefaults()

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

public getDefaults(mixed $fields) : array<string|int, mixed>
Parameters
$fields : mixed
Return values
array<string|int, mixed>

getRequired()

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

public getRequired(mixed $fields) : array<string|int, mixed>
Parameters
$fields : mixed
Return values
array<string|int, mixed>

getSubscribedEvents()

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

onApiPrepare_validate()

public onApiPrepare_validate(Event $event) : mixed
Parameters
$event : Event

API preparation event.

Tags
throws
Exception

        
On this page

Search results