AbstractChannelProvider
in package
implements
ChannelProviderInterface
Abstract base class for channel providers.
Tags
Interfaces, Classes, Traits and Enums
- ChannelProviderInterface
- Channel provider interface.
Table of Contents
- $coverRouter : Router
- Cover router
- $providerId : string
- Provider ID
- $recordRouter : Router
- Record router
- configureSearchParams() : void
- Hook to configure search parameters before executing search.
- setCoverRouter() : void
- Inject cover router
- setOptions() : void
- Set the options for the provider.
- setProviderId() : void
- Set an identifier that will be injected as the 'providerId' key of all channels created by this provider.
- setRecordRouter() : void
- Inject record router
- summarizeRecordDrivers() : array<string|int, mixed>
- Convert a search results object into channel contents.
Properties
$coverRouter
Cover router
protected
Router
$coverRouter
= null
$providerId
Provider ID
protected
string
$providerId
= ''
$recordRouter
Record router
protected
Router
$recordRouter
= null
Methods
configureSearchParams()
Hook to configure search parameters before executing search.
public
configureSearchParams(Params $params) : void
Parameters
- $params : Params
-
Search parameters to adjust
Tags
Return values
void —setCoverRouter()
Inject cover router
public
setCoverRouter(Router $coverRouter) : void
Parameters
- $coverRouter : Router
-
Cover router.
Return values
void —setOptions()
Set the options for the provider.
public
setOptions(array<string|int, mixed> $options) : void
Parameters
- $options : array<string|int, mixed>
-
Options
Tags
Return values
void —setProviderId()
Set an identifier that will be injected as the 'providerId' key of all channels created by this provider.
public
setProviderId(string $id) : void
Parameters
- $id : string
-
Provider ID
Return values
void —setRecordRouter()
Inject record router
public
setRecordRouter(Router $recordRouter) : void
Parameters
- $recordRouter : Router
-
Record router.
Return values
void —summarizeRecordDrivers()
Convert a search results object into channel contents.
protected
summarizeRecordDrivers(array<string|int, mixed>|Traversable $drivers) : array<string|int, mixed>
Parameters
- $drivers : array<string|int, mixed>|Traversable
-
Record drivers to summarize.