ChannelLoader
in package
Channel loader
Tags
Table of Contents
- $cacheManager : Manager
- Cache manager
- $channelManager : PluginManager
- Channel manager
- $config : Config
- Channel configuration
- $locale : string
- Current locale (used for caching)
- $recordLoader : Loader
- Record loader
- $searchRunner : SearchRunner
- Search runner
- __construct() : mixed
- Constructor
- getHomeContext() : array<string|int, mixed>
- Generates static front page of channels.
- getRecordContext() : array<string|int, mixed>
- Generates channels for a record.
- getSearchContext() : array<string|int, mixed>
- Generates channels for a search.
- getChannelProvider() : ChannelProviderInterface
- Convenience method to retrieve a channel provider.
- getChannelProviders() : array<string|int, mixed>
- Get an array of channel providers matching the provided IDs (or just one, if the channelProvider GET parameter is set).
- getChannelsFromResults() : array<string|int, mixed>
- Get channel details using an array of providers and a populated search results object.
- performChannelSearch() : Results
- Get a search results object configured by channel providers.
Properties
$cacheManager
Cache manager
protected
Manager
$cacheManager
$channelManager
Channel manager
protected
PluginManager
$channelManager
$config
Channel configuration
protected
Config
$config
$locale
Current locale (used for caching)
protected
string
$locale
$recordLoader
Record loader
protected
Loader
$recordLoader
$searchRunner
Search runner
protected
SearchRunner
$searchRunner
Methods
__construct()
Constructor
public
__construct(Config $config, Manager $cache, PluginManager $cm, SearchRunner $runner, Loader $loader[, string $locale = '' ]) : mixed
Parameters
- $config : Config
-
Channels configuration
- $cache : Manager
-
Cache manager
- $cm : PluginManager
-
Channel manager
- $runner : SearchRunner
-
Search runner
- $loader : Loader
-
Record loader
- $locale : string = ''
-
Current locale (used for caching)
Return values
mixed —getHomeContext()
Generates static front page of channels.
public
getHomeContext([string $token = null ][, string $activeChannel = null ][, string $activeSource = null ]) : array<string|int, mixed>
Parameters
- $token : string = null
-
Channel token (optional, used for AJAX fetching)
- $activeChannel : string = null
-
Channel being requested (optional, used w/ token)
- $activeSource : string = null
-
Search backend to use (null to use configured default).
Return values
array<string|int, mixed> —getRecordContext()
Generates channels for a record.
public
getRecordContext(string $recordId[, string $token = null ][, string $activeChannel = null ][, string $source = DEFAULT_SEARCH_BACKEND ]) : array<string|int, mixed>
Parameters
- $recordId : string
-
Record ID to load
- $token : string = null
-
Channel token (optional, used for AJAX fetching)
- $activeChannel : string = null
-
Channel being requested (optional, used w/ token)
- $source : string = DEFAULT_SEARCH_BACKEND
-
Search backend to use
Return values
array<string|int, mixed> —getSearchContext()
Generates channels for a search.
public
getSearchContext([array<string|int, mixed> $searchRequest = [] ][, string $token = null ][, string $activeChannel = null ][, string $source = DEFAULT_SEARCH_BACKEND ]) : array<string|int, mixed>
Parameters
- $searchRequest : array<string|int, mixed> = []
-
Request parameters
- $token : string = null
-
Channel token (optional, used for AJAX fetching)
- $activeChannel : string = null
-
Channel being requested (optional, used w/ token)
- $source : string = DEFAULT_SEARCH_BACKEND
-
Search backend to use
Return values
array<string|int, mixed> —getChannelProvider()
Convenience method to retrieve a channel provider.
protected
getChannelProvider(string $providerId) : ChannelProviderInterface
Parameters
- $providerId : string
-
Channel provider name and optional config (colon-delimited)
Return values
ChannelProviderInterface —getChannelProviders()
Get an array of channel providers matching the provided IDs (or just one, if the channelProvider GET parameter is set).
protected
getChannelProviders(string $source, array<string|int, mixed> $configSection[, string $activeId = null ]) : array<string|int, mixed>
Parameters
- $source : string
-
Search backend ID
- $configSection : array<string|int, mixed>
-
Configuration section to load ID list from
- $activeId : string = null
-
Currently selected channel ID (if any; used when making an AJAX request for a single additional channel)
Return values
array<string|int, mixed> —getChannelsFromResults()
Get channel details using an array of providers and a populated search results object.
protected
getChannelsFromResults(array<string|int, mixed> $providers, Results $results, string $token) : array<string|int, mixed>
Parameters
- $providers : array<string|int, mixed>
-
Array of channel providers
- $results : Results
-
Search results object from performChannelSearch
- $token : string
-
Optional channel token
Return values
array<string|int, mixed> —performChannelSearch()
Get a search results object configured by channel providers.
protected
performChannelSearch(array<string|int, mixed> $searchRequest, array<string|int, mixed> $providers, string $source) : Results
Parameters
- $searchRequest : array<string|int, mixed>
-
Search request parameters
- $providers : array<string|int, mixed>
-
Array of channel providers
- $source : string
-
Backend to use