CoolCMS API

DashboardAttention extends BaseComponent

in package

• Application

Dashboard band of cards for what waits for action in the admin.

Table of Contents

Constants

KEY_STATE_EXPIRED  : mixed = 'expired'

KEY_STATE_EXPIRING  : mixed = 'expiring'

Application key states as returned by the Api in `keys[].state`.

PAYMENT_STATUS_START  : mixed = 2

Payment in the "started" state: the customer left for the gateway and never came back.

STUCK_PAYMENT_HOURS  : mixed = 1

Hours in the "started" state after which a payment counts as stuck. A card payment finishes within a minute and a bank transfer within two days, so one hour is a safe threshold that does not catch normal traffic.

Properties

$container  : Container

$routerDispatcher  : RouterDispatcher

$translator  : ITranslator

$appContext  : AppContext

$componentParameters  : array<string, mixed>

$currencyContext  : CurrencyContext|null

$deviceDetector  : DeviceDetector|null

$languageContext  : LanguageContext|null

$localizationContext  : LocalizationContext|null

$settingContext  : SettingContext

$themeContext  : ThemeContext|null

$translatorDomain  : string|null

$apiClientManager  : ApiClientManager

$apiOverview  : array{clients: list>, defaultLimits: array}|null|false

Overview of applications with Api access, loaded once for both key cards.

$bazaarAdvertManager  : AdvertManager

$bazaarResponseManager  : ResponseManager

$comcatAdvertManager  : AdvertManager

$comcatResponseManager  : ResponseManager

$commentManager  : CommentManager

$complaintManager  : ComplaintManager

$emailQueueManager  : EmailQueueManager

$invoiceManager  : InvoiceManager

$orderManager  : OrderManager

$paymentManager  : PaymentManager

$ratingManager  : RatingManager

Methods

__call()  : mixed

Dispatches `renderXyz()` to `render('Xyz', ...$args)`.

__construct()  : mixed

countKeysInState()  : int

Counts keys in state `$state` of clients that are not revoked. The key state (`active`/`expiring`/`expired`/`revoked`) is computed by the Api; the "soon" threshold lives only there (`Api\ApiClientManager::EXPIRING_SOON_DAYS`) and is not duplicated here.

createComponent()  : IComponent|null

getAppContext()  : AppContext

getComponentParameter()  : mixed

Returns a component parameter, or null when it is not set.

getContainer()  : Container

getCurrencyContext()  : CurrencyContext|null

getLanguageContext()  : LanguageContext|null

getLocalizationContext()  : LocalizationContext|null

getRouterDispatcher()  : RouterDispatcher

getSettingContext()  : SettingContext

getSettings()  : array<int, array<string, mixed>>

getThemeContext()  : ThemeContext|null

hasServiceByType()  : bool

Returns whether the container has a service of the given type.

initializeAllContexts()  : void

injectDeviceDetector()  : void

onCreate()  : void

render()  : void

setAppContext()  : $this

setComponentParameter()  : void

Sets a component parameter.

setCurrencyContext()  : $this

setLanguageContext()  : $this

setLocalizationContext()  : $this

setSettingContext()  : $this

setThemeContext()  : $this

setup()  : void

setupAppContext()  : void

typedComponent()  : T

Returns a subcomponent with a verified type.

frontPresenter()  : BasePresenter|null

Returns the front presenter the component is attached to (null outside the front end or when detached).

getTranslator()  : ITranslator

setTemplateFile()  : void

setTranslator()  : self

buildHref()  : string|null

Returns the link to the target list, or `null` when the target does not exist in this installation.

collectCards()  : array<int, array{key: string, icon: string, count: int, href: string, tone: string}>

Cards with a nonzero count in order of urgency: money and customer first, cleanup last.

countApiKeys()  : int

Returns the number of application keys in the given state; on an Api read failure returns 0 and logs.

countBy()  : int

Counts records matching the filters.

createMultiplierComponent()  : Multiplier<string|int, IComponent>

Creates a multiplier for the component.

createNewComponentInstance()  : IComponent|null

Creates a new component instance without adding it to the presenter; used by the multiplier.

createStandardComponent()  : IComponent|null

Creates a standard component (not a multiplier).

definitions()  : array<int, array{key: string, privilege: string, icon: string, tone: string, destination: string, params: array, count: callable}>

Card definitions. Array order is page order.

isAllowedDestination()  : bool

Whether the user may open the target list. Read from the array loaded in the presenter's `startup()`, no extra query.

logDashboardFailure()  : void

A failure of one card is logged and the rest continues. Without the log a query error would show only as a vanished card, indistinguishable from "nothing to do".

pluralLabel()  : string

Returns the card label in the right plural form for the count.