AdminPayload  

class AdminPayload

Methods

array
pausedQueues()

The names of the queues currently paused on the active connection — powers the dashboard warning and the Advanced page toggle, regardless of the queue backend in use.

array
sortMaps()

The sort options each resource offers, keyed by resource type.

__construct(Container $container, SettingsRepositoryInterface $settings, ExtensionManager $extensions, ConnectionInterface $db, Dispatcher $events, Config $config, ApplicationInfoProvider $appInfo, MaintenanceMode $maintenance, FontAwesome $fontAwesome)

No description

void
__invoke(Document $document, ServerRequestInterface $request)

No description

array
getSearchDrivers()

No description

Details

at line 41
protected array pausedQueues()

The names of the queues currently paused on the active connection — powers the dashboard warning and the Advanced page toggle, regardless of the queue backend in use.

Return Value

array

at line 67
protected array sortMaps()

The sort options each resource offers, keyed by resource type.

The forum already receives this, as it is what the sort dropdown is built from and how `?sort=newest` in a URL becomes `-createdAt` for the API. The admin side needs the same list wherever it offers sorting as a setting, and assembling one in JavaScript would mean a second copy that silently omits whatever sorts extensions have added. Only aliased sorts appear: a sort without one is perfectly usable through the API, but has no name to put in front of an administrator. Resources with nothing to offer are left out rather than published empty.

Return Value

array

at line 88
__construct(Container $container, SettingsRepositoryInterface $settings, ExtensionManager $extensions, ConnectionInterface $db, Dispatcher $events, Config $config, ApplicationInfoProvider $appInfo, MaintenanceMode $maintenance, FontAwesome $fontAwesome)

Parameters

Container $container
SettingsRepositoryInterface $settings
ExtensionManager $extensions
ConnectionInterface $db
Dispatcher $events
Config $config
ApplicationInfoProvider $appInfo
MaintenanceMode $maintenance
FontAwesome $fontAwesome

at line 101
void __invoke(Document $document, ServerRequestInterface $request)

Parameters

Document $document
ServerRequestInterface $request

Return Value

void

at line 178
protected array getSearchDrivers()

Return Value

array