CoolCMS API

AdvertPresenter extends BasePresenter

in package

• Application

uses AdvertListTrait, AdvertFavListTrait, AdvertDetailTrait, PermissionTrait, CategoryTrait, RegionTrait, ParameterTrait, AddAdvertFormTrait, EditAdvertFormTrait, AdvertAuthorizationFormTrait, AdvertPasswordResetFormTrait, EditStatisticsTrait, EditResponsesTrait, EditRenewTrait, EditExtendTrait, EditDeleteTrait, ArraysInitTrait, UserInitTrait, FavouriteHandlerTrait, ReportTrait, FollowTrait

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'

advertSessionExpiration  : mixed = 7200

extendWindowDays  : mixed = 2

Number of days before expiration when extending is offered.

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.

LIST_INCLUDES  : mixed = ['parameterRels.parameter.translations', 'asset...

Includes of the list; identical for the DB path and the search endpoint.

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.

manageLinkKeyPrefix  : string = 'front.bazaar.presenters.advert.manageLink.'

passwordResetKeyPrefix  : string = 'front.bazaar.presenters.advert.passwordReset.'

responseDetailModalTarget  : mixed = 'responseDetailModal'

Unique key of the response detail modal in `ModalRegistry`.

sessionSection  : mixed = 'front.bazaar.advert.edit'

SPECIFICATION_SKIP_KEYS  : array<string|int, string> = ['name', 'keywords', 'text', 'type', 'state', '...

tabConfirm  : mixed = 'confirm'

tabDelete  : mixed = 'delete'

tabExtend  : mixed = 'extend'

tabForm  : mixed = 'form'

Tab keys of the edit page; they match the files in `Templates/Advert/Sections/Edit/`.

tabRenew  : mixed = 'renew'

tabResponses  : mixed = 'responses'

tabStatistics  : mixed = 'statistics'

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.

$advertFollowerManager  : AdvertFollowerManager

$advertLinksConfig  : AdvertLinksConfig

$advertParameterListFactory  : AdvertParameterListFactory

$advertPasswordResetManager  : AdvertPasswordResetManager

$advertReportManager  : AdvertReportManager

$advertStatisticsManager  : AdvertStatisticsManager

$authManager  : AuthManager

$authStorageManager  : AuthStorageManager

$blacklistedWordManager  : BlacklistedWordManager

$capabilityTokenIssuer  : CapabilityTokenIssuer

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

$categoryId  : string|null

$categorySlugTranslator  : CategoryNameTranslator

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

$catId  : array<string|int, int>|null

$consentGateFactory  : ConsentGateFactory

$container  : Container

$count  : int|null

$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

$forgotPasswordFormFactory  : ForgotPasswordFormFactory

$frontFormLimiter  : FrontFormLimiter

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

$modalRegistry  : ModalRegistry

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

$recommendFormFactory  : RecommendFormFactory

$regionSlugTranslator  : RegionNameTranslator

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

$responseFormFactory  : ResponseFormFactory

$responseManager  : ResponseManager

$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

$socialsShareFactory  : SocialsShareFactory

$tab  : string|null

Active section (tab) of the edit page; see `Templates/Advert/Sections/Edit/`.

$tariffManager  : TariffManager

$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

$advert  : Advert|null

$advertFormFactory  : AdvertFormFactory

$advertManager  : AdvertManager

$blacklistedWords  : array<string|int, string>

$categoryManager  : CategoryManager

$categoryNodesCache  : array<int, array<string, mixed>>|null

$currentCategory  : Category|null

$currentRegion  : Region|null

$esSearcher  : EsSearcher

$favouriteSessionSection  : string

$favouriteSnippets  : array<int, string>

$frontUserManager  : UserManager

$hasPaidAccess  : bool

$isLoggingIn  : bool

$parameterManager  : ParameterManager

$parameterValues  : array<string|int, object>

$regionManager  : RegionManager

$selectedCategoryList  : array<string|int, Category>

$theme  : Theme|null

Methods

__construct()  : mixed

actionAdd()  : void

actionDetail()  : void

actionEdit()  : void

actionFavouriteList()  : void

actionList()  : void

addFavouriteSnippets()  : void

authFormSucceeded()  : void

beforeRender()  : void

checkAccessPermission()  : bool

completeExternalLogin()  : bool

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

createComponent()  : IComponent|null

createComponentAdvertParameterList()  : AdvertParameterList

createComponentAuthForm()  : Form

createComponentConsentGate()  : ConsentGate

createComponentForgotPasswordForm()  : ForgotPasswordForm

createComponentPasswordResetForm()  : Form

createComponentRecommendForm()  : RecommendForm

createComponentResponseForm()  : ResponseForm

createComponentSocialsShare()  : SocialsShare

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

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

getAdvert()  : Advert|null

getContainer()  : Container

getCurrentCategory()  : Category|null

getCurrentRegion()  : Region|null

getDefaultUrlParams()  : array<string, null>

getFavouriteSnippets()  : array<int, string>

getPageEntity()  : Page|null

getRouterDispatcher()  : RouterDispatcher

getTranslator()  : ITranslator

handleAddToFavourites()  : void

handleChangeLocale()  : void

handleDeleteAdvert()  : void

Handles the advert deletion signal.

handleDelFromFavourites()  : void

handleExtendAdvert()  : void

Handles the advert extension signal before expiration.

handleFollow()  : void

handleLogout()  : void

handleRenewAdvert()  : void

Handles the renewal signal of an expired advert.

handleReport()  : void

Writes to the DB: AJAX from the page only; a bare GET (crawler, link prefetch) ends with 403.

handleShowPhone()  : void

Handles the "show phone" action of an advert.

handleShowResponseDetailModal()  : void

Handles the signal that shows the response detail in a modal window.

handleSignOut()  : void

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

handleUnfollow()  : void

hasServiceByType()  : bool

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

initCurrentCategory()  : void

initCurrentRegion()  : void

initFavourites()  : void

initializeTranslator()  : void

initParameterValues()  : self

initUser()  : void

loadModalWindowComponent()  : void

loginWithCredentials()  : void

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

passwordResetFormSucceeded()  : void

prepareFilters()  : array<int, Filter>

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.

refreshAdvertSession()  : void

Updates the session token after editing: rewrites the hash and extends the expiration.

renderAdd()  : void

renderAuthorizationForm()  : void

renderDetail()  : void

renderEdit()  : void

renderFavouriteList()  : void

renderList()  : void

renderPasswordReset()  : void

renderPermissionDenied()  : void

setAdvert()  : self

setConfigParameters()  : void

setFavouritesForTemplate()  : void

setFavouriteSnippets()  : void

setTranslator()  : $this

startup()  : void

typedComponent()  : T

Returns a subcomponent with a verified type.

buildSiteIdentity()  : SiteIdentityDto

checkAuthentication()  : void

createComponentAddAdvertForm()  : AdvertForm

createComponentCategorySelectForm()  : Form

createComponentEditAdvertForm()  : AdvertForm

createComponentFrontSystemModalWindows()  : ModalWindows

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

findExpressPaymentTariffs()  : iterable<string|int, ExpressTariffInterface>

Express payment offers whatever the advert can still be boosted with, so the quick prices have to come with the tariff — see {@see ExpressPaymentTrait}.

getExpressPaymentModuleCode()  : string

getExpressPaymentReference()  : string|null

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.

initFollower()  : void

initializeMetaData()  : void

initializeOgData()  : void

initializePresenterContext()  : void

initSiteIdentity()  : void

isAdvertExpired()  : bool

Returns whether the advert is expired, so the "Renew" tab is offered.

isAdvertNearExpiration()  : bool

Returns whether the advert is within `extendWindowDays` before expiration (and not yet expired), so the "Extend" tab is offered.

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.

prepareBlacklistedWords()  : void

prepareEditResponses()  : void

Prepares the data of the responses tab; `renderEdit()` calls it only when the tab is active.

prepareEditStatistics()  : void

Prepares the data of the statistics tab; `renderEdit()` calls it only when the tab is active.

prepareMetaData()  : MetaDataDTO

prepareOgData()  : OgDataDTO

prepareSpecifications()  : void

Builds the advert specifications array for rendering (name, value, type).

setTranslatorDomain()  : void

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

Builds the recursive category tree by `parentId`.

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

buildDefaultOgImage()  : OgImageDTO|null

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

buildEditTabs()  : array<int, string>

Builds the list of available tabs. Renew and Extend appear by the expiration state.

buildRegionSubtreeFilters()  : array<string|int, BaseFilter>

Builds the "in region" filter from the suggest (`REGION_PICKER`, `p[<id>]=<regionId>`): adverts whose region lies in the subtree of the selected node, so a county also finds the adverts of its municipalities. Same shape as the list by the region in the path ({@see RegionTrait::prepareRegionFilter()}). A nonexistent region means no filter (an invalid id from the URL must not hide the whole list).

buildResponseDetailContent()  : string

Builds the response detail HTML (a partial rendered to a string) for the modal content.

buildResponseDetailError()  : string

categoryLabel()  : string

checkAutorization()  : bool

Checks whether the current user may edit the advert.

checkUserPaymentValidity()  : bool

collectAdvertVisibilityIssues()  : array<int, string>

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

collectLeafItems()  : array<int, string>

Builds the flat list `{leafId => label}` for `addCheckboxList`; only leaf categories (without children) get a checkbox.

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.

extractBaseParameterIds()  : array<string|int, int>

Extracts the unique base `parameterId` from the URL keys (strips the suffixes `_from`, `_to`, `_d`, `_r`).

formatLayoutCandidates()  : array<int, string>

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

getClientIp()  : string

getFavouriteSection()  : SessionSection

getPasswordResetKey()  : string

grantAdvertEditCapability()  : void

Passes the fact that this visitor just proved the advert password to the Api layer. The token is minted again on every request from the current session state (already verified against the DB by the caller) and is never stored.

grantAdvertEditCapabilityFromSession()  : void

Issues the capability from the session before the advert is loaded. The Api verifies it itself (password digest from the DB in `ownsByCapability()`), so a stale session record opens nothing. Without it `get` for editing would give an anonymous editor a masked e-mail and the form would fail validation. {@see self::checkAutorization()} then issues the capability again after the check against the fresh hash, which stays decisive for access.

grantAdvertSessionAfterReset()  : void

Same session token as `AdvertAuthorizationFormTrait::authFormSucceeded()` writes after the password form. The hash is read back fresh from the Api — `checkAutorization()` compares it with the DB value on every request.

hasPaidLinks()  : bool

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

hasPasswordResetKey()  : bool

Does the request carry the reset key from the e-mailed link (query) or the form (POST)?

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

isAdvertOwner()  : bool

isCategoryBranchActive()  : bool

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

isCategoryStepCompleted()  : bool

isDevelopment()  : bool

isEntityInFavourites()  : bool

isRegionBranchActive()  : bool

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

layoutFileExists()  : bool

loadCategoryTree()  : array<string|int, Category>

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.

loadSelectedCategories()  : array<string|int, Category>

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

parseStatDate()  : DateTimeImmutable|null

Parses a date in the Y-m-d format; returns null otherwise.

prepareAdvertSearchFilter()  : Filter

Builds the fulltext filter through ES (ids become `SearchIdFilter`; visibility and paging stay in DB phase 1). When ES is off, down or the query is short, it transparently falls back to MySQL `MATCH_AGAINST` over `parameterRels.value`.

prepareCategoryFilter()  : void

prepareOrderBy()  : array<string, bool>

prepareOtherAdverts()  : void

Loads the other adverts of the owner and the count of their published adverts for the seller card.

prepareParameterFilter()  : void

preparePriceFilter()  : void

Adds the upper price bound from the URL (`?priceTo=...`) sent by `SearchBox`.

prepareRegionFilter()  : void

prepareSearchFilters()  : array<int, Filter>

Builds the filters for the search endpoint: everything except fulltext (the Api side does it, ES or `MATCH_AGAINST`). That is visibility + category/region + parameter filters from `$_GET['p']`, which are DB phase 1.

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 "advert management" link from the insertion e-mail (`edit?id=...&manageKey=...`), which replaces the readable password the e-mail carried before.

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.

resolveStatGranularity()  : string

Validates the granularity from the request against the allowed values.

resolveStatRange()  : DateTimeImmutable}

Returns the date range from the request. When a bound is missing or invalid, the default range of the granularity is used.

revokeTokensOnLogout()  : void

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

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

Searches adverts through the Api endpoint `api/bazaar/advert/search` instead of building the filter in the presenter. Three states:

setDefaultAvatar()  : array{rel: string}

setNetteUser()  : void

showResponseDetailModal()  : void

Registers the response detail modal and tells the container to show it.

tryRefresh()  : bool

Tries an automatic refresh when the access token has expired.