CoolCMS API

TaggedArticleList extends BaseComponent
in package
uses InitRenderTrait, ArticleListTrait

Articles list filtered by tags. A clone of `ArticleListProviderComponent` narrowed to one fixed `render()` contract: the template (template16 home page) only needs "list articles with this tag", so unlike the original there are no `renderRow()`/`renderCards()` variants and no optional `$orderBy`/`$filters` from outside.

Table of Contents

Properties

$container  : Container
$routerDispatcher  : RouterDispatcher
$translator  : ITranslator
$appContext  : AppContext
$componentParameters  : array<string, mixed>
$currencyContext  : CurrencyContext|null
$deviceDetector  : DeviceDetector|null
$headingTag  : string
$languageContext  : LanguageContext|null
$localizationContext  : LocalizationContext|null
$settingContext  : SettingContext
$themeContext  : ThemeContext|null
$translatorDomain  : string|null
$articleListFactory  : ArticleListRendererFactory
$articleManager  : ArticleManager

Methods

__call()  : mixed
Dispatches `renderXyz()` to `render('Xyz', ...$args)`.
__construct()  : mixed
createComponent()  : IComponent|null
createComponentFrontBlogArticleList()  : ArticleListRenderer
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
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).
intilializeRender()  : void
Builds the filters and loads the article list. Filter objects are built here in PHP, Latte does not build them; the template only passes the ready `$tagIds` on from `render()`.

Properties

$componentParameters

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

component parameters set by setComponentParameter()

$translatorDomain

protected string|null $translatorDomain = 'front.blog.components.TaggedArticleList'

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([array<int, int> $tagIds = [] ][, string $style = 'Cards' ][, int $maxNumber = 5 ][, string $headingTag = 'div' ]) : void
Parameters
$tagIds : array<int, int> = []

tag ids for the tags.id IN (...) filter, built in PHP (see InitRenderTrait::intilializeRender()). An empty array means no tag filter: the component then behaves as a plain list and does not fail.

$style : string = 'Cards'
$maxNumber : int = 5
$headingTag : string = 'div'

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

intilializeRender()

Builds the filters and loads the article list. Filter objects are built here in PHP, Latte does not build them; the template only passes the ready `$tagIds` on from `render()`.

private intilializeRender(array<int, int> $tagIds[, int $maxNumber = 5 ]) : void

The tag filter (tags.id IN (...)) is assigned first: tags is an M2M collection on Article and id is the identifier of Tag; JoinHelper resolves the path tags.id as a left join of article.tags plus a WHERE on the tag alias id.

The activated/published filters are assigned after the tag filter, so the same key from the tag filter can be overwritten but not the other way around. The front end must never list an inactive or unpublished article, even when the caller passes empty or nonsensical $tagIds.

Empty $tagIds add no tag filter at all and the component behaves as a plain list. A tag without articles gives an empty $articleList, which ArticleListRenderer renders as its usual empty state, not as an error.

Parameters
$tagIds : array<int, int>
$maxNumber : int = 5
On this page

Search results