CoolCMS API

AdvertRenderer extends BaseComponent

in package

• Application

uses MultipliableTrait, ToggleRedrawTrait, FavouriteTrait, FollowTrait

Renders one advert in a list. Used via `{multicontrol}` from `AdvertListRenderer` (Multiplier, key = advertId), so each advert has its own isolated `advert` snippet and an AJAX toggle (favorite/follow) redraws only that item.

Table of Contents

Constants

DESC_LIMIT  : int = 150

Visible characters of the description a highlighted snippet may have. Must match `|truncate:150` in Style_1..3, otherwise the list would "bloat" on search.

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

$selectedStyle  : string|null

$settingContext  : SettingContext

$themeContext  : ThemeContext|null

$translatorDomain  : string|null

$advert  : Advert|null

$advertFollowerManager  : AdvertFollowerManager

$advertManager  : AdvertManager

$favouriteRedrawSnippets  : array<string|int, string>

Snippets / snippet areas redrawn after an AJAX toggle. Separate for favourite and follow — each action may refresh a different part.

$favouriteSessionSection  : string

$followRedrawSnippets  : array<string|int, string>

$headingTag  : string

$multiplierItemId  : string|int|null

$multiplierRenderMethod  : string|null

$multiplierUniqueKey  : string|null

$renderingDefault  : bool

Guard against the `renderDefault()` and `render()` delegation loop.

$session  : Session

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

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

getLanguageContext()  : LanguageContext|null

getLocalizationContext()  : LocalizationContext|null

getMultiplierItemId()  : string|int|null

getMultiplierRenderMethod()  : string|null

Returns the render method of the multiplier.

getMultiplierUniqueKey()  : string|null

Returns the unique key of the multiplier.

getRouterDispatcher()  : RouterDispatcher

getSettingContext()  : SettingContext

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

getThemeContext()  : ThemeContext|null

handleAddToFavourites()  : void

handleDelFromFavourites()  : void

handleFollow()  : void

handleUnfollow()  : void

hasServiceByType()  : bool

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

initFavourites()  : void

initializeAllContexts()  : void

injectDeviceDetector()  : void

isFollowing()  : bool

isInFavourites()  : bool

isInMultiplier()  : bool

Returns whether the component is rendered inside a multiplier.

loadAdvert()  : Advert|null

Loads an advert by ID and caches it into $this->advert. Also called from the signal handlers (Favourite/Follow), where there is no multiplier context and render() would otherwise not resolve the advert.

onCreate()  : void

render()  : void

setAdvert()  : self

setAppContext()  : $this

setComponentParameter()  : void

Sets a component parameter.

setCurrencyContext()  : $this

setFavouriteRedrawSnippets()  : self

setFollowRedrawSnippets()  : self

setHeadingTag()  : self

setLanguageContext()  : $this

setLocalizationContext()  : $this

setMultiplierContext()  : void

Sets the multiplier context; called automatically from `MultiControlMacros`.

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

handleMultiplierSuccess()  : void

Handles a successful action in a multiplier (e.g. a form submit) and redraws the right snippet.

renderDefault()  : void

Aliases `render()` when no other render method is specified.

setTemplateFile()  : void

setTranslator()  : self

availableRenderStyles()  : array<int, string>

Returns styles derived from public `renderXxx()` methods, without `render()` and `renderDefault()`.

availableRenderStylesHint()  : string

Returns the message suffix listing styles; empty when the component has none.

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

finishToggle()  : void

Finishes a toggle signal: sets the style (so the default is not rendered after AJAX), redraws the given snippets of this component and flash messages.

firstRenderStyle()  : string|null

Returns the first available style, used as an example in the message.

getFavouriteSection()  : SessionSection

getFollowUserId()  : int|null

prepareTemplate()  : void

resolveAdvert()  : Advert|null

Advert resolution: 1) explicitly set, 2) already loaded in the parent AdvertListRenderer (no extra query), 3) loaded by the multiplier key (fallback for a standalone AJAX signal).

resolveHighlights()  : array<string, string>

Returns snippets for this advert. Same path as {@see resolveParameterOptions()}: the parent {@see AdvertListRenderer} holds the data and the item renderer fetches it via the multiplier. A standalone AJAX signal (favorite/follow) has no parent and returns an empty array, so the redrawn advert has no highlighting (and no error).

resolveIsHighlighted()  : bool

Returns whether the paid "Highlighting" is active (card tint via the class `highlighted`), via the parent like {@see resolveHighlights()}: the set is held by {@see AdvertListRenderer::isHighlighted()}; a standalone AJAX redraw of the item without a parent fails open to `false` (card without tint, no error).

resolveParameterOptions()  : array<string|int, object>

resolveStyleFromMultiplier()  : string|null

'style2' becomes 'Style_2'. After an AJAX signal the style comes primarily from `$selectedStyle` (passed by the signal); this is the multiplier-context fallback.