CoolCMS API

MessagePresenter extends BasePresenter

in package

• Application

uses MessageInitTrait, MessageListTrait, MessageDetailTrait, MessageReplyFormTrait

Messages: the mailbox of the logged-in user.

Table of Contents

Constants

DEFAULT_URL_PARAMS  : mixed = [ 'page' => null, 'view' => null, 'order' => nu...

URL state reset for a link that starts a new flow (e.g. "Add advert" from a list).

DEFUALT_URL_PARAMS  : mixed = self::DEFAULT_URL_PARAMS

DETAIL_SLUG  : mixed = \App\Core\Routers\PageId::BASE_MESSAGE_DETAIL

Slug of the conversation detail page.

IDENTITY_LOCALIZED_KEYS  : mixed = ['site.name', 'site.tagline']

Text identity keys that have language variants `<key>.<alias>`.

LIST_SLUG  : mixed = \App\Core\Routers\PageId::BASE_MESSAGE_LIST

Slug of the conversation list page (fixed id, project convention).

SESSION_NAMESPACE  : mixed = 'front'

FALLBACK_LAYOUT  : mixed = '@layout_one.latte'

Layout used when the theme lacks the requested one.

IDENTITY_ASSET_KEYS  : mixed = ['site.logo.assetId' => 'setLogo', 'site.logo.d...

Setting key to DTO setter; the order matches the form fields.

IDENTITY_MODULE  : mixed = 1

Identity settings live in the System module.

LOCALE_MAP  : mixed = ['cs' => 'cs_CZ', 'en' => 'en_US', 'sk' => 'sk_...

Maps the short language code to the full locale of the registered NEON sources.

Properties

$accessTokenValidator  : AccessTokenValidator

Validates access tokens beyond signature and expiry.

$accountDeletionSessionManager  : AccountDeletionSessionManager

Account deletion — cancel ticket of a sign-in refused while the account awaits deletion.

$authManager  : AuthManager

$authStorageManager  : AuthStorageManager

$box  : string

Mailbox: `received` / `sent`; empty means both.

$container  : Container

$currencyContext  : CurrencyContext

$currencyManager  : CurrencyManager

$deviceDetector  : DeviceDetector

$displayPaymentRegionManager  : PaymentRegionManager

IMPORTANT: a custom name, not `$paymentRegionManager`. Several presenters (Discussion/Bazaar Payment) have the region manager in the constructor, and a same-named property would break the container ("Cannot redeclare").

$eventDispatcher  : EventDispatcher

$googleIntegrations  : GoogleIntegrations

Google services from the third-party connections, used in the page head (`analytics.latte` templates).

$identityAssetManager  : AssetManager

$jwtManager  : JwtManager

$languageContext  : LanguageContext

$languageManager  : LanguageManager

$localizationContext  : LocalizationContext

$localizationManager  : LocalizationManager

$loginDeviceCookie  : LoginDeviceCookie

"Known device" cookie for the password login throttle ({@see self::rememberLoginDevice()}).

$modalWindowsFactory  : ModalWindowsFactory

$pageManager  : PageManager

$presenterContext  : PresenterContext

$reCaptchaRuntime  : ReCaptchaRuntime

Decides at runtime whether forms use reCAPTCHA (configuration plus the connection set up in the admin).

$routerDispatcher  : RouterDispatcher

$securityConfig  : SecurityConfig

reCAPTCHA switch for templates (`$reCaptchaEnabled` in the `scripts.latte` templates).

$settingContext  : SettingContext

$settingManager  : SettingManager

$siteBaseUrl  : SiteBaseUrl

Website address for links outside the request; public because components use it (`MessageInfoLine`).

$slug  : string|int|null

$themeContext  : ThemeContext

$themeManager  : ThemeManager

$themeResolver  : DefaultThemeResolver

$translator  : ITranslator

$translatorSessionResolver  : Session

$unread  : bool

Show only conversations with an unread message.

$userManager  : UserManager

$debugMode  : bool

$metaData  : MetaDataDTO|null

$ogData  : OgDataDTO|null

$pageEntity  : Page|null

$productionMode  : bool

$siteIdentity  : SiteIdentityDto|null

$translatorDomain  : string

$isLoggingIn  : bool

$messageManager  : MessageManager

$messageParticipantManager  : MessageParticipantManager

$messageThreadManager  : MessageThreadManager

$newMessageIds  : array<int, true>

$openedThread  : MessageThread|null

$participantViews  : array<int, MessageParticipantView>

$readMessageIds  : array<int, true>

$systemEvents  : array<int, array{event: string, name: string}>

$theme  : Theme|null

$threadMessages  : array<int, Message>

Methods

__construct()  : mixed

actionDetail()  : void

actionList()  : void

beforeRender()  : void

completeExternalLogin()  : bool

Completes an OAuth login (`LoginExternalComponent`) with the same storage as a password login.

createComponent()  : IComponent|null

formatLayoutTemplateFiles()  : array<string|int, mixed>

Returns candidate layout files; Nette takes the first existing one.

getContainer()  : Container

getDefaultUrlParams()  : array<string, null>

getPageEntity()  : Page|null

getRouterDispatcher()  : RouterDispatcher

getTranslator()  : ITranslator

handleChangeLocale()  : void

handleHide()  : void

"Delete for me": the thread stays for the other party.

handleLogout()  : void

handleSignOut()  : void

Sign-out from an ordinary link (account menu), also without JavaScript.

handleSwitchBox()  : void

Switches the mailbox without reloading the whole page.

hasServiceByType()  : bool

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

initializeTranslator()  : void

loadModalWindowComponent()  : void

loginWithCredentials()  : void

Logs in by username and password; called only by the login form (after validation and CSRF).

onReplySuccess()  : void

redirectToPendingAccountDeletion()  : void

Account deletion: a sign-in (password or OAuth) was refused because the account awaits deletion: keep the cancel ticket in the session and go to the "Account deletion" page, which offers "Cancel the deletion". Without a ticket (should not happen) the visitor gets the plain refusal flash instead.

renderDetail()  : void

renderList()  : void

setConfigParameters()  : void

setTranslator()  : $this

startup()  : void

typedComponent()  : T

Returns a subcomponent with a verified type.

buildSiteIdentity()  : SiteIdentityDto

checkAuthentication()  : void

createComponentFrontSystemModalWindows()  : ModalWindows

createComponentReplyForm()  : Form

currentAbsoluteUrl()  : string

Returns `link('//this')`, or the request address without query when it cannot be built.

fallbackToMainLocalization()  : bool

Whether the presenter may fall back to the main localization for an unknown locale; a regular page may not (404).

getSessionKey()  : string

Returns a session key string, e.g. 'front.auth.step1'.

getSessionSection()  : SessionSection

Returns a Nette\SessionSection instance using a dynamically built session key.

initializeMetaData()  : void

initializeOgData()  : void

initializePresenterContext()  : void

initSiteIdentity()  : void

isSameSiteRequest()  : bool

Tells whether the request comes from the own site (Nette SameSite cookie); protects GET actions with a side effect.

loadPageEntity()  : Page|null

Returns the page of the request by `slug` (empty is the home page, a number is the ID, otherwise `href`).

logout()  : void

metaData()  : MetaDataDTO

Returns the page meta data; filled by startup, an empty DTO before that.

ogData()  : OgDataDTO

Returns the page OG data; filled by `initializeOgData()` in startup, an empty DTO before that.

prepareMetaData()  : MetaDataDTO

prepareOgData()  : OgDataDTO

resolveBox()  : MessageBox|null

Mailbox from the persistent parameter; `null` means both (received and sent).

setTranslatorDomain()  : void

buildDefaultOgImage()  : OgImageDTO|null

Builds the default OG image from the site identity (admin, settings, site identity).

buildSystemEvents()  : array<int, array{event: string, name: string}>

Builds the system messages "X joined / left the conversation". The message text in the DB is a code (see {@see MessageSystemEvent}); the sentence is composed here from the translation and the participant's current name (also a former one, the Api still returns the row).

collectGuestContacts()  : array<int, MessageParticipantView>

Returns contacts of participants without an account: the only way to reply to an `email_only` thread.

createIdentity()  : SimpleIdentity|null

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

expireIdleLogin()  : bool

Checks whether the login expired from inactivity.

findMyParticipantRow()  : MessageParticipant|null

My participant row (`myList`, the caller's only); carries `last_read_datetime` and the counter.

formatLayoutCandidates()  : array<int, string>

getClientIp()  : string

getCurrentUserId()  : int|null

identitySetting()  : string

Returns the module 1 key value as a string (empty when the key is missing or not a scalar).

identitySettingOrNull()  : string|null

Works like {@see identitySetting()}, but an empty value is null (the template omits the field).

indexById()  : array<int, MessageParticipantView>

initConversation()  : void

Loads messages and participants (other party's name, guest contact) and counts new messages.

initializeDisplayRegion()  : void

Initializes the currency and VAT display of prices.

initializeExternalFiles()  : void

initializeMetaTags()  : void

initializePage()  : void

isDevelopment()  : bool

layoutFileExists()  : bool

loadIdentityAssets()  : array<int, Asset>

Loads the identity assets by id, keyed by id.

loadLocalization()  : Localization|null

Returns the localization by `loc` from the URL, or `null` when there is no such locale.

loadMyParticipantsByThread()  : array<int, MessageParticipant>

Returns my participant rows by thread; they carry unread, role and archive.

loadThread()  : MessageThread|null

localizationCurrencyKey()  : string|null

Front needs no currency key from the localization; the currency and the display region are filled by {@see CurrencyInitTrait::initializeDisplayRegion()}.

localizedIdentitySetting()  : string

Returns the language-dependent identity value: `<key>.<page language alias>`; an empty or missing value falls back to the base key (default language). An empty string means neither is set.

logoutNetteUser()  : void

processFailedLogin()  : void

processInvalidToken()  : void

processLogin()  : void

processLoginException()  : void

processMissingToken()  : void

processSuccessfulLogin()  : void

processValidToken()  : void

readLoginDeviceToken()  : string|null

Returns the raw known-device cookie for the Api login (the Api verifies its signature).

redirectAfterLoginAction()  : void

Ends a sign-in attempt. A classic (non-AJAX) successful sign-in lands on "My account" ({@see PageId::SYSTEM_USER_ACCOUNT}); a failed one on the home page. An AJAX sign-in stays on the current page and only redraws the flash messages.

refreshNetteIdentity()  : bool

Refreshes the token for the same logged-in user.

rememberLoginDevice()  : void

Issues or renews the "known device" cookie after a successful login (password or OAuth).

requireLoggedUser()  : int

resolveLoginErrorMessage()  : string

Resolves the translated login error text.

revokeTokensOnLogout()  : void

Calls the Api logout (revokes the refresh family and deny-lists the access `jti`) for the tokens of the current session.

setNetteUser()  : void

tryRefresh()  : bool

Tries an automatic refresh when the access token has expired.