CoolCMS API

NewsletterAddressPresenter extends BasePresenter

in package

• Application

Table of Contents

Constants

defaultLinkParameters  : mixed = ['slug' => NULL]

SESSION_NAMESPACE  : mixed = 'script'

FALLBACK_LAYOUT  : mixed = '@layout_one.latte'

Layout used when the theme lacks the requested one.

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

$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

$jwtManager  : JwtManager

$languageContext  : LanguageContext

$languageManager  : LanguageManager

$localizationContext  : LocalizationContext

$localizationManager  : LocalizationManager

$loginDeviceCookie  : LoginDeviceCookie

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

$pageManager  : PageManager

$presenterContext  : PresenterContext

$settingContext  : SettingContext

$settingManager  : SettingManager

$slug  : string|int|null

$themeContext  : ThemeContext

$themeManager  : ThemeManager

$themeResolver  : DefaultThemeResolver

$translator  : ITranslator

$translatorSessionResolver  : Session

$userManager  : UserManager

$debugMode  : bool

$newsletterAddressManager  : NewsletterAddressManager

$pageEntity  : Page|null

$productionMode  : bool

$translatorDomain  : string

$isLoggingIn  : bool

$theme  : Theme|null

Methods

__construct()  : mixed

actionActivate()  : void

actionUnsubscribe()  : void

Unsubscribes the address from the link in a newsletter e-mail: the address row is deleted. The link carries the e-mail and the address key; a wrong pair (a test e-mail, an old link) only shows the error message.

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

getPageEntity()  : Page|null

getTranslator()  : ITranslator

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

initializeTranslator()  : void

loginWithCredentials()  : void

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

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.

renderActivate()  : void

renderUnsubscribe()  : void

setConfigParameters()  : void

setTranslator()  : $this

startup()  : void

typedComponent()  : T

Returns a subcomponent with a verified type.

checkAuthentication()  : void

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.

initializePresenterContext()  : 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

setTranslatorDomain()  : void

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.

flashConfirmation()  : void

IMPORTANT: the flash gets the finished translation, not a key and not a {@see \App\Core\Utils\Controls\FlashMessage} object.

formatLayoutCandidates()  : array<int, string>

getClientIp()  : string

initializeDisplayRegion()  : void

Initializes the currency and VAT display of prices.

initializeExternalFiles()  : void

initializeMetaTags()  : void

initializePage()  : void

isDevelopment()  : bool

layoutFileExists()  : bool

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

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.

redirectToHomepage()  : never

IMPORTANT: `slug` must be `null`, not `1`. The homepage route has the slug in its mask with a default, so a concrete value stops it matching and `redirect()` ends with `InvalidLinkException: No route for Front:System:Page:homepage(slug=1)` and HTTP 500, at a point where the address is already activated in the DB.

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.

sendUnsubscribeConfirmation()  : never

Plain confirmation page with a button that posts the same link (scripts have no theme templates).

setNetteUser()  : void

tryRefresh()  : bool

Tries an automatic refresh when the access token has expired.