CoolCMS API

PageSection extends BaseComponent
in package

FinalYes

Page section (`page_sections`): a named HTML block inserted into templates by key.

Usage:

{control frontSystemPageSection 'homepage-how'}  {* or :plain for content only *}

IMPORTANT: the parameter order render(string $key, string $style) is the reverse of RegionList::render(), because {control name arg} calls render() positionally; otherwise $style would receive the key. renderPlain() swaps the order for the plain style.

IMPORTANT: a nonexistent, deleted or inactive key renders nothing (no error, no placeholder); in debug mode a warning goes to the page-section log channel.

content is output with |noescape; that is safe only because the field is filled by the admin under RBAC (Admin:System:PageSection), never by visitor input.

IMPORTANT: several sections on one page need {multicontrol frontSystemPageSection-homepageHow 'homepage-how'}, otherwise they share $uniqueId. The instance key must not contain a dash: a dash is the component path separator, so -homepage-how fails with "Component with name 'how' does not exist."

Table of Contents

Constants

LOG_CHANNEL  : mixed = 'page-section'

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
$pageSectionManager  : PageSectionManager

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
renderPlain()  : void
The `plain` style: content only, no heading and no wrapper. Own override outside the generic `__call()` dispatch, see the class docblock.
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).
loadActiveSection()  : PageSection|null
logSkip()  : void
Silent in production; only in debug mode, so a missing seed does not spam the production log.
resolveTranslation()  : PageSectionText|null
Translation for the current language; when missing or disabled (`activeTranslation = 0`), falls back to the default website language, the same as for pages (see the class docblock). Without a match returns `null` and `render()` renders an empty heading and content: the section exists and is active, just without text in either language, which unlike a nonexistent or inactive key is not logged as an error.

Constants

LOG_CHANNEL

private mixed LOG_CHANNEL = 'page-section'

Properties

$componentParameters

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

component parameters set by setComponentParameter()

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

public render([string $key = '' ][, string $style = 'Default' ]) : void
Parameters
$key : string = ''
$style : string = 'Default'

renderPlain()

The `plain` style: content only, no heading and no wrapper. Own override outside the generic `__call()` dispatch, see the class docblock.

public renderPlain([string $key = '' ]) : void
Parameters
$key : string = ''

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

logSkip()

Silent in production; only in debug mode, so a missing seed does not spam the production log.

private logSkip(string $key, string $reason) : void
Parameters
$key : string
$reason : string

resolveTranslation()

Translation for the current language; when missing or disabled (`activeTranslation = 0`), falls back to the default website language, the same as for pages (see the class docblock). Without a match returns `null` and `render()` renders an empty heading and content: the section exists and is active, just without text in either language, which unlike a nonexistent or inactive key is not logged as an error.

private resolveTranslation(PageSection $entity) : PageSectionText|null
Parameters
$entity : PageSection
Return values
PageSectionText|null
On this page

Search results