CoolCMS API

MessagePresenter extends BasePresenter

in package

• Application

uses PaginationTrait, MessageInitTrait, MessageListTrait, MessageDetailTrait, MessageConfirmTrait, MessageFavListTrait, FavouriteHandlerTrait, MessageFormTrait, MessageGuestEditTrait, CategoryTrait, UserInitTrait

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

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

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

SESSION_NAMESPACE  : mixed = 'front'

FALLBACK_LAYOUT  : mixed = '@layout_one.latte'

Layout used when the theme lacks the requested one.

guestEditSessionExpiration  : int = 7200

Length of the edit session opened by the link, in seconds (same as an advert after the password).

guestEditSessionSection  : string = 'front.discussion.message.edit'

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.

LIST_INCLUDES  : mixed = ['asset', 'categories.translations', 'commentTh...

Includes of the list, the same for the plain DB path and the search endpoint. The post image is `asset`; there is no `image` association.

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.

$advertLinksConfig  : AdvertLinksConfig

$authManager  : AuthManager

$authStorageManager  : AuthStorageManager

$capabilityTokenIssuer  : CapabilityTokenIssuer

Issuer of the capability token for the Api layer (see {@see self::hasGuestEditAccess()}).

$categorySlugTranslator  : CategoryNameTranslator

Router translator, the same one that builds the slug from the id in links (see init below).

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

$id  : int

$identityAssetManager  : AssetManager

$jwtManager  : JwtManager

$languageContext  : LanguageContext

$languageManager  : LanguageManager

$linksPaymentItemManager  : PaymentItemManager

$localizationContext  : LocalizationContext

$localizationManager  : LocalizationManager

$loginDeviceCookie  : LoginDeviceCookie

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

$messageFormFactory  : MessageFormFactory

$messageInfoLineFactory  : MessageInfoLineFactory

$modalWindowsFactory  : ModalWindowsFactory

$name  : string|null

$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

$userManager  : UserManager

$debugMode  : bool

$metaData  : MetaDataDTO|null

$ogData  : OgDataDTO|null

$pageEntity  : Page|null

$productionMode  : bool

$siteIdentity  : SiteIdentityDto|null

$translatorDomain  : string

$categoryManager  : CategoryManager

$currentCategory  : Category|null

$esSearcher  : EsSearcher

$favouriteSessionSection  : string

$favouriteSnippets  : array<int, string>

$fromEs  : bool

True when order and `totalCount` come from Elasticsearch (relevance).

$isLoggingIn  : bool

$message  : Message|null

$messageManager  : MessageManager

$messages  : array<string|int, Message>

$profiles  : array<int, PublicProfile>

$searchHighlights  : array<int, array<string, string>>

$socialsShareFactory  : SocialsShareFactory

$theme  : Theme|null

Methods

__construct()  : mixed

actionAdd()  : void

actionDetail()  : void

actionEdit()  : void

Edit of a post: the logged-in author, or a guest author with an edit session opened by the "Manage post" link from the insert e-mail ({@see MessageGuestEditTrait}).

actionFavouriteList()  : void

actionHomepage()  : void

actionList()  : void

addFavouriteSnippets()  : void

beforeRender()  : void

completeExternalLogin()  : bool

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

createComponent()  : IComponent|null

createComponentSocialsShare()  : SocialsShare

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

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

getContainer()  : Container

getCurrentCategory()  : Category|null

getDefaultUrlParams()  : array<string, null>

getFavouriteSnippets()  : array<int, string>

getMessage()  : Message|null

getPageEntity()  : Page|null

getRouterDispatcher()  : RouterDispatcher

getTranslator()  : ITranslator

handleAddToFavourites()  : void

handleChangeLocale()  : void

handleConfirm()  : void

Confirms the post by the key from the e-mail link.

handleDelFromFavourites()  : void

handleLogout()  : void

handleSignOut()  : void

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

hasServiceByType()  : bool

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

initCurrentCategory()  : void

initFavourites()  : void

initializeTranslator()  : void

initUser()  : void

loadModalWindowComponent()  : void

loginWithCredentials()  : void

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

paginationInit()  : Paginator|null

prepareUserForDetail()  : void

prepareUserForList()  : 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.

renderAdd()  : void

renderDetail()  : void

renderEdit()  : void

renderFavouriteList()  : void

renderList()  : void

requirePagination()  : Paginator

Works like `paginationInit()`, but the paginator is required; a missing component is a wiring error.

setConfigParameters()  : void

setFavouritesForTemplate()  : void

setFavouriteSnippets()  : void

setTranslator()  : $this

startup()  : void

typedComponent()  : T

Returns a subcomponent with a verified type.

buildSiteIdentity()  : SiteIdentityDto

checkAuthentication()  : void

createComponentFrontSystemModalWindows()  : ModalWindows

createComponentMessageForm()  : MessageForm

createComponentMessageInfoLine()  : Multiplier<string|int, MessageInfoLine>

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

getFavouriteIds()  : array<int, int>

getFavouriteSessionStorage()  : Session

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

setTranslatorDomain()  : void

buildDefaultOgImage()  : OgImageDTO|null

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

collectMessageVisibilityIssues()  : array<int, string>

Returns the reasons why the post is not publicly visible; an empty array means the post is fine.

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.

formatLayoutCandidates()  : array<int, string>

getClientIp()  : string

getFavouriteSection()  : SessionSection

grantMessageEditCapability()  : void

The token is minted again on every request from the verified session state and never stored.

grantMessageEditCapabilityFromSession()  : void

Issues the capability from the session before the post is loaded, so `get` for editing returns the guest's own e-mail unmasked. The Api verifies it itself (fingerprint of the secret from the DB), so a stale session row opens nothing; {@see self::hasGuestEditAccess()} stays decisive for access.

guestEditAccess()  : AdvertAccessSession

hasGuestEditAccess()  : bool

Returns whether this visitor holds a valid edit session for the post. The session row must match the secret of the post loaded from the DB and must not be expired; otherwise it is revoked.

hasPaidLinks()  : bool

True when the message has an active, valid item of the "Show links" tariff (`AdvertLinksConfig`, default 4): the text then shows its web addresses as links.

hideMessageDetail()  : void

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

initializeDisplayRegion()  : void

Initializes the currency and VAT display of prices.

initializeExternalFiles()  : void

initializeMetaTags()  : void

initializePage()  : void

isCategoryBranchActive()  : bool

Whether the category and all its ancestors are active (nested set: an ancestor encloses lft/rgt).

isDevelopment()  : bool

isEntityInFavourites()  : bool

isMessageAuthor()  : bool

Author is the logged-in user who inserted the post (an anonymous post has no author password).

isMessageEditor()  : bool

The logged-in author edits their post; a guest post only with a valid edit session from the link.

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.

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

prepareCanonicalUrl()  : void

prepareCategoryFilter()  : void

prepareFilters()  : array<int, Filter>

prepareImageGallery()  : void

prepareMessageSearchFilter()  : Filter

Full-text search through Elasticsearch (ids go to `SearchIdFilter`; visibility, level and pagination stay in the DB phase 1). When Elasticsearch is disabled, down or the query is short, it transparently falls back to MySQL `MATCH_AGAINST` over subject and text.

prepareOgDataForDetail()  : void

prepareOgDataForList()  : void

prepareOrderBy()  : array<string, bool>

preparePerPage()  : int

prepareView()  : 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).

redeemManageKeyFromLink()  : void

Handles the "Manage post" link: a valid key opens the edit session, an invalid or expired one gives a message (the edit then ends on "permission denied"). Redirects without the key either way.

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

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.

searchViaApi()  : Message>, 1: int, 2: bool, 3: array>}|null

Searches through the Api endpoint `api/discussion/message/search`.

setDefaultAvatar()  : array{rel: mixed}

setNetteUser()  : void

tryRefresh()  : bool

Tries an automatic refresh when the access token has expired.