Subscriber
Table of Contents
Classes
- APIv3SchemaAdapter
- This class determines what fields are allowed for a request
and validates that the fields are provided correctly.
- ChainSubscriber
- The ChainSubscriber looks for API parameters which specify a nested or
chained API call. For example:
- DebugSubscriber
- Class XDebugSubscriber
- DynamicFKAuthorization
- This is only used by the APIv3 "Attachment" entity.
- I18nSubscriber
- Class I18nSubscriber
- PermissionCheck
- For any API requests that correspond to a Doctrine entity
($apiRequest['doctrineClass']), check permissions specified in
Civi\API\Annotation\Permission.
- TransactionSubscriber
- Class TransactionSubscriber
- WhitelistSubscriber
- The WhitelistSubscriber listens to API requests and matches them against
a whitelist of allowed API calls. If an API call does NOT appear in the
whitelist, then it generates an error.
- WrapperAdapter
- This is a wrapper for the legacy "API Wrapper" interface which allows
wrappers to run through the new kernel. It translates from dispatcher events
('civi.api.prepare', 'civi.api.respond') to wrapper calls ('fromApiInput', 'toApiOutput').
- DynamicFKAuthorizationTest
- Base class for CiviCRM unit tests
- TransactionSubscriberTest
- Base class for CiviCRM unit tests
- WhitelistSubscriberTest
- The WhitelistSubscriber enforces security policies
based on API whitelists. This test combines a number
of different policies with different requests and
determines if the policies are correctly enforced.