CoolCMS API

ProductCategoryList extends BaseComponent

in package

• Application

uses InitializationTrait, CategoryRailTrait, PreferredCategoryCutTrait

Renders the sidebar category tree.

Table of Contents

Constants

CATEGORY_RAIL_STYLES  : array<string|int, mixed> = ['Style_2', 'Style_4', 'Style_5', 'Style_6']

Styles that can be drawn from the shared template.

CATEGORY_RAIL_TEMPLATE_DIR  : string = __DIR__ . '/../../../Base/Front/Components/Cate...

Shared templates of {@see CATEGORY_RAIL_STYLES} for all modules.

Properties

$container  : Container

$routerDispatcher  : RouterDispatcher

$showAll  : bool

Expands the preferred list to all root categories.

$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

$categoryRailAllCategories  : array<string|int, object>

Flat tree (`lft`/`rgt`) filled in `InitializationTrait::initializeRender()`; the base of the subtree sum in {@see categoryRailCount()}.

$categoryRailCountMap  : array<int, int>|null

Memoized {@see ProductCategoryManager::fetchProductCounts()}: one bridge call per render, although `categoryRailCount()` is called for every row separately.

$categoryRailWithCount  : bool

Whether the category list carries the product count (`count` in the rows of shared templates).

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

Tree from {@see TreeStructure::prepareForTemplate()}; never mutated, assigned to the template by value.

$loadedCategories  : array<string|int, BaseEntity>|null

Categories loaded once per component instance (the query does not depend on render arguments).

$manager  : ProductCategoryManager

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

Renders a row tile: icon on the left, name next to it.

renderLink()  : void

Renders a row of links: the text variant of {@see renderHorizontalCompact()} with the count in parentheses after the name (computed, see {@see categoryRailCount()}).

renderTile()  : void

Renders a tile: a flat signpost of root categories with the icon centered on top and no subcategories (see {@see renderTileGroup()} for those).

renderTileGroup()  : void

Renders a tile with a group of subcategories: a colored area with an icon and the first `$subItemCount` children (default 3), below it the category name and the subtree product count (computed, see {@see categoryRailCount()}).

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.

applyPreferredCut()  : void

Cuts `sortedItems` to the preferred roots and fills `preferredOnly`, `showAll` and `hiddenCount` for the template. Called after the current category context is resolved (it must search the whole tree) and before the rail rows are built from `sortedItems`.

buildCategoryRailParent()  : array{name: string, href: string}|null

Returns the way one level up: the first item of the strip when the current category has a parent.

buildCategoryRailRows()  : array<int, array{id: int|null, name: string, href: string, count: int|null, iconPath: string|null, asset: object|null, iconClass: string|null, active: bool, children: array}>

Converts tree nodes into plain arrays for the template.

categoryRailCount()  : int|null

Returns the number of products in the category including its subtree.

categoryRailHref()  : string

Returns the category list target for the shared `Style_4` and `Style_5` styles ({@see CategoryRailTrait}).

categoryRailTemplateDir()  : string

Returns the directory to load the template from.

frontPresenter()  : BasePresenter|null

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

getTranslator()  : ITranslator

prepareCategoryRail()  : void

Fills `$railRows` and `$railParent` for the shared templates.

setTemplateFile()  : void

setTranslator()  : self

categoryRailCurrentId()  : int|null

categoryRailIconPath()  : string|null

Returns the legacy icon path, or `null` when unusable.

categoryRailName()  : string

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

getActivePath()  : array<int, int>

getCurrentCategory()  : ProductCategory|null

initializeRender()  : void