CoolCMS API

CategoryChildrenList extends BaseComponent

in package

• Application

uses BlogListTargetTrait, CategoryChildrenTrait

One category level (children of the current category), unlike the full-tree `CategoryList`.

Table of Contents

Constants

BLOG_LIST_ARTICLE  : mixed = 'article'

BLOG_LIST_EVENT  : mixed = 'event'

BLOG_LIST_NEWS  : mixed = 'news'

CATEGORY_CHILDREN_STYLES  : array<string|int, mixed> = ['Style_1', 'Style_4', 'Style_6']

Flat list is the shared `Style_1`; the others are contextual rail styles.

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

$settingContext  : SettingContext

$themeContext  : ThemeContext|null

$translatorDomain  : string|null

$categoryManager  : CategoryManager

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

getLanguageContext()  : LanguageContext|null

getLocalizationContext()  : LocalizationContext|null

getRouterDispatcher()  : RouterDispatcher

getSettingContext()  : SettingContext

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

getThemeContext()  : ThemeContext|null

hasServiceByType()  : bool

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

initializeAllContexts()  : void

injectDeviceDetector()  : void

onCreate()  : void

render()  : void

renderHorizontalCompact()  : void

renderVertical()  : void

setAppContext()  : $this

setComponentParameter()  : void

Sets a component parameter.

setCurrencyContext()  : $this

setLanguageContext()  : $this

setLocalizationContext()  : $this

setSettingContext()  : $this

setThemeContext()  : $this

setup()  : void

setupAppContext()  : void

typedComponent()  : T

Returns a subcomponent with a verified type.

blogListParams()  : array<string, mixed>

Link parameters for a list with a category and a preserved region (same rule as in Bazaar): with a region selected the category segment is always explicit (`-` means none), otherwise the region in the URL would shift into the category position. Without a region nothing changes.

blogListTarget()  : array{0: string, 1: int}

blogListTargetForPage()  : array{0: string, 1: int}

Target by the current page (for components without an item): news are pages 52/53, events 54/55, otherwise articles.

blogRegionLinks()  : array<int, string>

Links to the list of the same type filtered by the item region (`/clanky/-/<region>`).

categoryChildrenRootHref()  : string

categoryChildrenTemplateDir()  : string

categoryRailHref()  : string

frontPresenter()  : BasePresenter|null

Returns the front presenter the component is attached to (null outside the front end or when detached).

getTranslator()  : ITranslator

prepareCategoryChildren()  : void

setTemplateFile()  : void

setTranslator()  : self

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

listHref()  : string

Stays on the current listing page; a category change always starts at page 1.

resolveCurrentCategory()  : object|null

The page's category, but only when it belongs to this module — a component placed on another module's page must not adopt that module's category.