CoolCMS API

NotificationBell extends BaseComponent

in package

• Application

Notification bell in the admin header: an icon button with a red dot and a Bootstrap dropdown with the last {@see PANEL_LIMIT} notifications.

Table of Contents

Constants

DETAIL_DESTINATION  : mixed = ':Admin:System:Notification:edit'

Notification detail: target of the cogwheel and fallback when the type has nowhere to link.

FALLBACK_ICON  : mixed = 'fa-solid fa-circle-info'

Icon for a type without its own, so a row never has an empty icon.

LIST_DESTINATION  : mixed = ':Admin:System:Notification:show'

Notification list: target of the "show all" button.

PANEL_LIMIT  : mixed = 10

How many latest notifications the panel shows.

TIME_FORMAT  : mixed = 'j.n.Y H:i'

Time format of a panel item (same as `DateTimeRenderer` in grids).

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

$notificationManager  : NotificationManager

$notificationTargets  : NotificationTargetResolver

Methods

__call()  : mixed

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

__construct()  : mixed

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

handleMarkAllRead()  : void

Marks all unread notifications as read (the dot goes out).

handleRefresh()  : void

Manual list refresh (button in the panel header). The list is otherwise filled only at page load, so it gets stale in a long-open admin.

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

buildScopeFilters()  : array<int, Filter>

Bell scope: global rows plus rows targeted at the given user. The OR is one group filter, so Doctrine parenthesizes it and `read = 0` applies to both branches.

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).

findUnread()  : array<int, Notification>

hasUnread()  : bool

Tells whether the dot is lit. The dot means "an unread notification exists", any one, not just among the displayed ones. When it is visible in the loaded ten, the answer is ready and no extra query runs; the query is paid only when the last ten are all read.

prepareItems()  : array<int, array{id: int, title: string, text: string, time: string, read: bool, failed: bool, icon: string, href: string|null, detailHref: string}>

Returns the panel items: the last {@see PANEL_LIMIT} notifications, newest first.

redrawPanel()  : void

Redraws the list and the badge. Without JS (naja did not catch the link) it ends with a redirect to the same page: the panel closes, but the data is fresh after the reload, so the action is not lost.

resolveHref()  : string|null

Returns the click-through of an item: editing of the record the notification was raised for (`itemId`, not `notification_id`). `null` makes the item plain text: a type without a target in the map, a target the admin has no privilege for, or a notification without `itemId`, which stays detached after the target record is deleted and must not lead to a 404.

resolveUserId()  : int|null

Returns the logged-in admin id, or null without an identity (then nothing is shown or marked).