ListItems
extends AbstractChannelProvider
in package
Uses
TranslatorAwareTrait
"List items" channel provider.
Tags
Table of Contents
- $andTags : bool
- Whether to use AND operator when filtering by tag.
- $coverRouter : Router
- Cover router
- $displayPublicLists : bool
- Should we pull in public list results in addition to the inclusion list in $ids?
- $ids : array<string|int, mixed>
- IDs of lists to display
- $initialListsToDisplay : int
- How many lists should we display before switching over to tokens?
- $providerId : string
- Provider ID
- $recordRouter : Router
- Record router
- $resultsManager : PluginManager
- $tags : array<string|int, mixed>
- Tags of lists to display
- $tagsService : TagsService
- $translator : TranslatorInterface
- Translator
- $url : Url
- $userListService : UserListServiceInterface
- __construct() : mixed
- Constructor
- configureSearchParams() : void
- Hook to configure search parameters before executing search.
- getFromRecord() : array<string|int, mixed>
- Return channel information derived from a record driver object.
- getFromSearch() : array<string|int, mixed>
- Return channel information derived from a search results object.
- getTranslator() : TranslatorInterface
- Get translator object.
- getTranslatorLocale() : string
- Get the locale from the translator.
- 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
- setTranslator() : TranslatorAwareInterface
- Set a translator
- translate() : string
- Translate a string (or string-castable object)
- translateWithPrefix() : string
- Translate a string (or string-castable object) using a prefix, or without the prefix if a prefixed translation is not found.
- addPublicLists() : array<string|int, UserListEntityInterface>
- Given an array of lists, add public lists if configured to do so.
- buildListChannels() : array<string|int, mixed>
- Build all of the channel data.
- extractTextDomain() : array<string|int, mixed>
- Given a translation string with or without a text domain, return an array with the raw string and the text domain separated.
- getChannelFromList() : array<string|int, mixed>
- Given a list object, return a channel array.
- getDebugTranslation() : string
- Build a debug-mode translation
- getLists() : array<string|int, UserListEntityInterface>
- Get a list of public lists to display:
- getListsById() : array<string|int, UserListEntityInterface>
- Get a list of lists, identified by ID; filter to public lists only.
- getListsByTagAndId() : array<string|int, UserListEntityInterface>
- Get a list of public lists, identified by ID and tag.
- sanitizeTranslationKey() : string
- Make sure there are not any illegal characters in the translation key that might prevent successful lookup in language files.
- summarizeRecordDrivers() : array<string|int, mixed>
- Convert a search results object into channel contents.
- translateString() : string
- Get translation for a string
Properties
$andTags
Whether to use AND operator when filtering by tag.
protected
bool
$andTags
$coverRouter
Cover router
protected
Router
$coverRouter
= null
$displayPublicLists
Should we pull in public list results in addition to the inclusion list in $ids?
protected
bool
$displayPublicLists
$ids
IDs of lists to display
protected
array<string|int, mixed>
$ids
$initialListsToDisplay
How many lists should we display before switching over to tokens?
protected
int
$initialListsToDisplay
$providerId
Provider ID
protected
string
$providerId
= ''
$recordRouter
Record router
protected
Router
$recordRouter
= null
$resultsManager
protected
PluginManager
$resultsManager
$tags
Tags of lists to display
protected
array<string|int, mixed>
$tags
$tagsService
protected
TagsService
$tagsService
$translator
Translator
protected
TranslatorInterface
$translator
= null
$url
protected
Url
$url
$userListService
protected
UserListServiceInterface
$userListService
Methods
__construct()
Constructor
public
__construct(UserListServiceInterface $userListService, Url $url, PluginManager $resultsManager, TagsService $tagsService[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $userListService : UserListServiceInterface
-
UserList database service
- $url : Url
-
URL helper
- $resultsManager : PluginManager
-
Results manager
- $tagsService : TagsService
-
Tags service
- $options : array<string|int, mixed> = []
-
Settings (optional)
Return values
mixed —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 —getFromRecord()
Return channel information derived from a record driver object.
public
getFromRecord(AbstractBase $driver[, string $channelToken = null ]) : array<string|int, mixed>
Parameters
- $driver : AbstractBase
-
Record driver
- $channelToken : string = null
-
Token identifying a single specific channel to load (if omitted, all channels will be loaded)
Tags
Return values
array<string|int, mixed> —getFromSearch()
Return channel information derived from a search results object.
public
getFromSearch(Results $results[, string $channelToken = null ]) : array<string|int, mixed>
Parameters
- $results : Results
-
Search results
- $channelToken : string = null
-
Token identifying a single specific channel to load (if omitted, all channels will be loaded)
Tags
Return values
array<string|int, mixed> —getTranslator()
Get translator object.
public
getTranslator() : TranslatorInterface
Return values
TranslatorInterface —getTranslatorLocale()
Get the locale from the translator.
public
getTranslatorLocale([string $default = 'en' ]) : string
Parameters
- $default : string = 'en'
-
Default to use if translator absent.
Return values
string —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
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 —setTranslator()
Set a translator
public
setTranslator(TranslatorInterface $translator) : TranslatorAwareInterface
Parameters
- $translator : TranslatorInterface
-
Translator
Return values
TranslatorAwareInterface —translate()
Translate a string (or string-castable object)
public
translate(string|object|array<string|int, mixed> $target[, array<string|int, mixed> $tokens = [] ][, string $default = null ][, bool $useIcuFormatter = false ][, array<string|int, string> $fallbackDomains = [] ]) : string
Parameters
- $target : string|object|array<string|int, mixed>
-
String to translate or an array of text domain and string to translate
- $tokens : array<string|int, mixed> = []
-
Tokens to inject into the translated string
- $default : string = null
-
Default value to use if no translation is found (null for no default).
- $useIcuFormatter : bool = false
-
Should we use an ICU message formatter instead of the default behavior?
- $fallbackDomains : array<string|int, string> = []
-
Text domains to check if no match is found in the domain specified in $target
Return values
string —translateWithPrefix()
Translate a string (or string-castable object) using a prefix, or without the prefix if a prefixed translation is not found.
public
translateWithPrefix(string $prefix, string|object|array<string|int, mixed> $target[, array<string|int, mixed> $tokens = [] ][, string $default = null ][, bool $useIcuFormatter = false ][, array<string|int, string> $fallbackDomains = [] ]) : string
Parameters
- $prefix : string
-
Translation key prefix
- $target : string|object|array<string|int, mixed>
-
String to translate or an array of text domain and string to translate
- $tokens : array<string|int, mixed> = []
-
Tokens to inject into the translated string
- $default : string = null
-
Default value to use if no translation is found (null for no default).
- $useIcuFormatter : bool = false
-
Should we use an ICU message formatter instead of the default behavior?
- $fallbackDomains : array<string|int, string> = []
-
Text domains to check if no match is found in the domain specified in $target
Return values
string —addPublicLists()
Given an array of lists, add public lists if configured to do so.
protected
addPublicLists(array<string|int, UserListEntityInterface> $lists) : array<string|int, UserListEntityInterface>
Parameters
- $lists : array<string|int, UserListEntityInterface>
-
List to expand.
Return values
array<string|int, UserListEntityInterface> —buildListChannels()
Build all of the channel data.
protected
buildListChannels(string $channelToken) : array<string|int, mixed>
Parameters
- $channelToken : string
-
Token identifying a single specific channel to load (if omitted, all channels will be loaded)
Return values
array<string|int, mixed> —extractTextDomain()
Given a translation string with or without a text domain, return an array with the raw string and the text domain separated.
protected
extractTextDomain(string|object|array<string|int, mixed> $target) : array<string|int, mixed>
Parameters
- $target : string|object|array<string|int, mixed>
-
String to translate or an array of text domain and string to translate
Return values
array<string|int, mixed> —getChannelFromList()
Given a list object, return a channel array.
protected
getChannelFromList(UserListEntityInterface $list, bool $tokenOnly) : array<string|int, mixed>
Parameters
- $list : UserListEntityInterface
-
User list
- $tokenOnly : bool
-
Return only token information?
Return values
array<string|int, mixed> —getDebugTranslation()
Build a debug-mode translation
protected
getDebugTranslation(string $domain, string $str, array<string|int, mixed> $tokens) : string
Parameters
- $domain : string
-
Text domain
- $str : string
-
String to translate
- $tokens : array<string|int, mixed>
-
Tokens to inject into the translated string
Return values
string —getLists()
Get a list of public lists to display:
protected
getLists() : array<string|int, UserListEntityInterface>
Return values
array<string|int, UserListEntityInterface> —getListsById()
Get a list of lists, identified by ID; filter to public lists only.
protected
getListsById(array<string|int, int> $ids) : array<string|int, UserListEntityInterface>
Parameters
- $ids : array<string|int, int>
-
IDs to retrieve
Return values
array<string|int, UserListEntityInterface> —getListsByTagAndId()
Get a list of public lists, identified by ID and tag.
protected
getListsByTagAndId() : array<string|int, UserListEntityInterface>
Return values
array<string|int, UserListEntityInterface> —sanitizeTranslationKey()
Make sure there are not any illegal characters in the translation key that might prevent successful lookup in language files.
protected
sanitizeTranslationKey(string $key) : string
Parameters
- $key : string
-
Key to sanitize
Return values
string —Sanitized key
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.
Return values
array<string|int, mixed> —translateString()
Get translation for a string
protected
translateString(string $rawStr[, array<string|int, mixed> $tokens = [] ][, string $default = null ][, string $domain = 'default' ][, bool $useIcuFormatter = false ]) : string
Parameters
- $rawStr : string
-
String to translate
- $tokens : array<string|int, mixed> = []
-
Tokens to inject into the translated string
- $default : string = null
-
Default value to use if no translation is found (null for no default).
- $domain : string = 'default'
-
Text domain (omit for default)
- $useIcuFormatter : bool = false
-
Should we use an ICU message formatter instead of the default behavior?