CoolCMS API

Menu extends BaseComponent
in package
uses InitializationTrait

Table of Contents

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
$menuManager  : MenuManager

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
Default rendering: horizontal menu (backward compatibility).
renderHorizontal()  : void
Horizontal menu with nested submenus.
renderIcons()  : void
Icon strip: items shown only as icons, the name goes into `u-sr-only`.
renderLinkHorizontal()  : void
Horizontal menu: links only (no submenus).
renderLinkVertical()  : void
Vertical menu: links only (no submenus).
renderVertical()  : void
Vertical menu with nested submenus.
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.
frontPresenter()  : BasePresenter|null
Returns the front presenter the component is attached to (null outside the front end or when detached).
getTranslator()  : ITranslator
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).
initializeRender()  : void
visibleItems()  : array<int, MenuItem>
Items the visitor may see: active, for the login state, with a name in the current language.

Properties

$componentParameters

protected array<string, mixed> $componentParameters = []

component parameters set by setComponentParameter()

$translatorDomain

protected string|null $translatorDomain = 'front.system.components.menu'

Methods

__call()

Dispatches `renderXyz()` to `render('Xyz', ...$args)`.

public __call(string $name, array<string|int, mixed> $args) : mixed

Called only when the component has no renderXyz() method of its own.

Parameters
$name : string
$args : array<string|int, mixed>

createComponent()

public createComponent(string $name) : IComponent|null
Parameters
$name : string
Return values
IComponent|null

getComponentParameter()

Returns a component parameter, or null when it is not set.

public getComponentParameter(string $name) : mixed
Parameters
$name : string

getContainer()

public getContainer() : Container
Return values
Container

getSettings()

public getSettings() : array<int, array<string, mixed>>
Return values
array<int, array<string, mixed>>

hasServiceByType()

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

public hasServiceByType(string $className) : bool

The name is composed dynamically (module plus component), so class_exists() runs first, and a true result guarantees a valid type.

Parameters
$className : string
Tags
phpstan-assert-if-true

class-string $className

Return values
bool

render()

Default rendering: horizontal menu (backward compatibility).

public render(int $menuId[, string|null $htmlId = null ][, bool $buttonOnLeft = false ][, string|null $label = null ]) : void
Parameters
$menuId : int
$htmlId : string|null = null
$buttonOnLeft : bool = false
$label : string|null = null

renderHorizontal()

Horizontal menu with nested submenus.

public renderHorizontal(int $menuId[, string|null $htmlId = null ][, bool $buttonOnLeft = false ][, string|null $label = null ]) : void
Parameters
$menuId : int
$htmlId : string|null = null
$buttonOnLeft : bool = false
$label : string|null = null

renderIcons()

Icon strip: items shown only as icons, the name goes into `u-sr-only`.

public renderIcons(int $menuId[, string|null $htmlId = null ][, bool $buttonOnLeft = false ][, string|null $label = null ]) : void

The icon comes from the icon_class column of the menu item, so the links (typically social networks) are managed in the admin as an ordinary menu, not hard-coded in the template.

Parameters
$menuId : int
$htmlId : string|null = null
$buttonOnLeft : bool = false
$label : string|null = null

renderLinkHorizontal()

Horizontal menu: links only (no submenus).

public renderLinkHorizontal(int $menuId[, string|null $htmlId = null ][, bool $buttonOnLeft = false ][, string|null $label = null ]) : void
Parameters
$menuId : int
$htmlId : string|null = null
$buttonOnLeft : bool = false
$label : string|null = null

renderLinkVertical()

Vertical menu: links only (no submenus).

public renderLinkVertical(int $menuId[, string|null $htmlId = null ][, bool $buttonOnLeft = false ][, string|null $label = null ]) : void
Parameters
$menuId : int
$htmlId : string|null = null
$buttonOnLeft : bool = false
$label : string|null = null

renderVertical()

Vertical menu with nested submenus.

public renderVertical(int $menuId[, string|null $htmlId = null ][, bool $buttonOnLeft = false ][, string|null $label = null ]) : void
Parameters
$menuId : int
$htmlId : string|null = null
$buttonOnLeft : bool = false
$label : string|null = null

setComponentParameter()

Sets a component parameter.

public setComponentParameter(string $name, mixed $value) : void
Parameters
$name : string
$value : mixed

typedComponent()

Returns a subcomponent with a verified type.

public typedComponent(string $name, T> $type) : T

Use it instead of an inline @var above $this['x'] (which does not narrow the type) and instead of the generic IComponent that $this['x'] returns. See Form::typedComponent().

Parameters
$name : string
$type : T>
Tags
template
Return values
T

frontPresenter()

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

protected frontPresenter() : BasePresenter|null
Return values
BasePresenter|null

getTranslator()

protected getTranslator() : ITranslator
Return values
ITranslator

setTemplateFile()

protected setTemplateFile(string $dir, string $filename) : void
Parameters
$dir : string
$filename : string

setTranslator()

protected setTranslator(ITranslator $translator) : self
Parameters
$translator : ITranslator
Return values
self

createMultiplierComponent()

Creates a multiplier for the component.

private createMultiplierComponent(string $name) : Multiplier<string|int, IComponent>
Parameters
$name : string
Return values
Multiplier<string|int, IComponent>

createNewComponentInstance()

Creates a new component instance without adding it to the presenter; used by the multiplier.

private createNewComponentInstance(string $baseName[, int|string|null $uniqueKey = null ]) : IComponent|null
Parameters
$baseName : string
$uniqueKey : int|string|null = null
Return values
IComponent|null

createStandardComponent()

Creates a standard component (not a multiplier).

private createStandardComponent(string $name) : IComponent|null
Parameters
$name : string
Return values
IComponent|null

initializeRender()

private initializeRender(int $menuId[, string|null $htmlId = null ][, bool $buttonOnLeft = false ][, string|null $label = null ]) : void
Parameters
$menuId : int
$htmlId : string|null = null
$buttonOnLeft : bool = false
$label : string|null = null

visibleItems()

Items the visitor may see: active, for the login state, with a name in the current language.

private visibleItems(array<int|string, MenuItem> $items, bool $loggedIn, int $languageId) : array<int, MenuItem>

IMPORTANT: the filters items.active and items.forLogged / items.forUnlogged in the query only pick the menu (a menu with at least one such item); the included collection items is loaded whole. An item hidden in the admin (the help page item with active = 0) was therefore still rendered. An item without a name in the current language rendered as an empty link (or an empty submenu block). The descendants of a dropped item are dropped with it (nested set: lft/rgt inside its interval), otherwise they would attach to an unrelated node of the tree.

Parameters
$items : array<int|string, MenuItem>
$loggedIn : bool
$languageId : int
Return values
array<int, MenuItem>
On this page

Search results