Comment on page
Data providers
Data providers are the core means to access external data. These are classes which use custom methods to access data.
Available data providers:
A
DataProvider
interface is used which defines the following common methods for data providers.Return base URI to use for all data requests.
- Returns a string
Return URI to use for current data request
- Parameters
string|null $endpoint
Optional endpoint to append to base URI
- Returns a string
Return a unique identifier safe to use for caching based on the request
- Parameters
$uri
URI for requestarray $context
Array of contextual data (e.g. request options)
- Returns a string
Whether errors are suppressed
- Returns a boolean
Return default decoder to decode responses.
- Returns an object of type
Strata\Data\Decode\DecoderInterface
or null if no default decoder set
Decode a response
- Parameters
mixed $response
Response to decode (normally an object or array)DecoderInterface|null $decoder
Optional decoder, if not set uses getDefaultDecoder()
- Returns the decoded data (normally an array or object)
Is the cache enabled?
- Returns a boolean
Return the cache
- Returns an object of type
Strata\Data\Cache\DataCache
- Parameters
string $eventName
Event namecallable $listener
The listenerint $priority
The higher this value, the earlier an event listener will be triggered in the chain (defaults to 0)
- Parameters
EventSubscriberInterface $subscriber
Event subscriber
Dispatches an event to all registered listeners
- Parameters
Event $event
The event to pass to the event handlers/listenersstring $eventName
The name of the event to dispatch
- Returns an object of type
Symfony\Contracts\EventDispatcher\Event
Last modified 9mo ago