CoolCMS API

ArticleListProvider extends BaseComponent
in package
uses InitRenderTrait, ArticleListTrait

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
renderBox()  : void
renderCards()  : void
renderCarousel()  : void
renderCompact()  : void
renderEditorial()  : void
renderHorizontalCards()  : void
renderHorizontalCompact()  : void
renderLine()  : void
renderRanked()  : void
renderRow()  : void
renderTable()  : 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).
initRender()  : void

Properties

$componentParameters

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

component parameters set by setComponentParameter()

$translatorDomain

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

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 $style = 'Row' ][, array<string|int, mixed> $orderBy = ['id' => false] ][, int $maxNumber = 5 ][, string $headingTag = 'div' ][, array<string|int, int> $showOnlyCategoryIds = [] ][, array<string, object> $filters = [] ]) : void
Parameters
$style : string = 'Row'
$orderBy : array<string|int, mixed> = ['id' => false]
$maxNumber : int = 5
$headingTag : string = 'div'
$showOnlyCategoryIds : array<string|int, int> = []
$filters : array<string, object> = []

filters on top of the base visibility (active and already published); built in PHP by the calling component, the template only passes them on because Latte does not build filter objects

renderBox()

public renderBox([array<string|int, mixed> $orderBy = ['id' => false] ][, int $maxNumber = 5 ][, string $headingTag = 'div' ][, array<string|int, int> $showOnlyCategoryIds = [] ][, array<string, object> $filters = [] ]) : void
Parameters
$orderBy : array<string|int, mixed> = ['id' => false]
$maxNumber : int = 5
$headingTag : string = 'div'
$showOnlyCategoryIds : array<string|int, int> = []
$filters : array<string, object> = []

same as in render()

renderCards()

public renderCards([array<string|int, mixed> $orderBy = ['id' => false] ][, int $maxNumber = 5 ][, string $headingTag = 'div' ][, array<string|int, int> $showOnlyCategoryIds = [] ][, array<string, object> $filters = [] ]) : void
Parameters
$orderBy : array<string|int, mixed> = ['id' => false]
$maxNumber : int = 5
$headingTag : string = 'div'
$showOnlyCategoryIds : array<string|int, int> = []
$filters : array<string, object> = []

same as in render()

renderCarousel()

public renderCarousel([array<string|int, mixed> $orderBy = ['id' => false] ][, int $maxNumber = 5 ][, string $headingTag = 'div' ][, array<string|int, int> $showOnlyCategoryIds = [] ][, array<string, object> $filters = [] ]) : void
Parameters
$orderBy : array<string|int, mixed> = ['id' => false]
$maxNumber : int = 5
$headingTag : string = 'div'
$showOnlyCategoryIds : array<string|int, int> = []
$filters : array<string, object> = []

same as in render()

renderCompact()

public renderCompact([array<string|int, mixed> $orderBy = ['id' => false] ][, int $maxNumber = 5 ][, string $headingTag = 'div' ][, array<string|int, int> $showOnlyCategoryIds = [] ][, array<string, object> $filters = [] ]) : void
Parameters
$orderBy : array<string|int, mixed> = ['id' => false]
$maxNumber : int = 5
$headingTag : string = 'div'
$showOnlyCategoryIds : array<string|int, int> = []
$filters : array<string, object> = []

same as in render()

renderEditorial()

public renderEditorial([array<string, bool> $orderBy = ['id' => false] ][, int $maxNumber = 5 ][, string $headingTag = 'div' ][, array<int, int> $showOnlyCategoryIds = [] ][, array<string, object> $filters = [] ]) : void
Parameters
$orderBy : array<string, bool> = ['id' => false]
$maxNumber : int = 5
$headingTag : string = 'div'
$showOnlyCategoryIds : array<int, int> = []
$filters : array<string, object> = []

same as in render()

renderHorizontalCards()

public renderHorizontalCards([array<string|int, mixed> $orderBy = ['id' => false] ][, int $maxNumber = 5 ][, string $headingTag = 'div' ][, array<string|int, int> $showOnlyCategoryIds = [] ][, array<string, object> $filters = [] ]) : void
Parameters
$orderBy : array<string|int, mixed> = ['id' => false]
$maxNumber : int = 5
$headingTag : string = 'div'
$showOnlyCategoryIds : array<string|int, int> = []
$filters : array<string, object> = []

same as in render()

renderHorizontalCompact()

public renderHorizontalCompact([array<string|int, mixed> $orderBy = ['id' => false] ][, int $maxNumber = 5 ][, string $headingTag = 'div' ][, array<string|int, int> $showOnlyCategoryIds = [] ][, array<string, object> $filters = [] ]) : void
Parameters
$orderBy : array<string|int, mixed> = ['id' => false]
$maxNumber : int = 5
$headingTag : string = 'div'
$showOnlyCategoryIds : array<string|int, int> = []
$filters : array<string, object> = []

same as in render()

renderLine()

public renderLine([array<string, bool> $orderBy = ['id' => false] ][, int $maxNumber = 5 ][, string $headingTag = 'div' ][, array<int, int> $showOnlyCategoryIds = [] ][, array<string, object> $filters = [] ]) : void
Parameters
$orderBy : array<string, bool> = ['id' => false]
$maxNumber : int = 5
$headingTag : string = 'div'
$showOnlyCategoryIds : array<int, int> = []
$filters : array<string, object> = []

same as in render()

renderRanked()

public renderRanked([array<string|int, mixed> $orderBy = ['id' => false] ][, int $maxNumber = 5 ][, string $headingTag = 'div' ][, array<string|int, int> $showOnlyCategoryIds = [] ][, array<string, object> $filters = [] ]) : void
Parameters
$orderBy : array<string|int, mixed> = ['id' => false]
$maxNumber : int = 5
$headingTag : string = 'div'
$showOnlyCategoryIds : array<string|int, int> = []
$filters : array<string, object> = []

same as in render()

renderRow()

public renderRow([array<string|int, mixed> $orderBy = ['id' => false] ][, int $maxNumber = 5 ][, string $headingTag = 'div' ][, array<string|int, int> $showOnlyCategoryIds = [] ][, array<string, object> $filters = [] ]) : void
Parameters
$orderBy : array<string|int, mixed> = ['id' => false]
$maxNumber : int = 5
$headingTag : string = 'div'
$showOnlyCategoryIds : array<string|int, int> = []
$filters : array<string, object> = []

same as in render()

renderTable()

public renderTable([array<string|int, mixed> $orderBy = ['id' => false] ][, int $maxNumber = 5 ][, string $headingTag = 'div' ][, array<string|int, int> $showOnlyCategoryIds = [] ][, array<string, object> $filters = [] ]) : void
Parameters
$orderBy : array<string|int, mixed> = ['id' => false]
$maxNumber : int = 5
$headingTag : string = 'div'
$showOnlyCategoryIds : array<string|int, int> = []
$filters : array<string, object> = []

same as in render()

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

initRender()

private initRender([int $maxNumber = 5 ][, array<string|int, mixed> $orderBy = ['id' => false] ][, array<string|int, int> $showOnlyCategoryIds = [] ][, array<string, object> $extraFilters = [] ]) : void
Parameters
$maxNumber : int = 5
$orderBy : array<string|int, mixed> = ['id' => false]
$showOnlyCategoryIds : array<string|int, int> = []

limits the list to articles in any of these categories (categories.id IN (...), same path shape as tags.id in TaggedArticleList); empty = all categories. It overrides a categoryId key of $extraFilters.

$extraFilters : array<string, object> = []

filters on top of the base visibility. They are assigned first and the visibility filters (activated, published) after them, so the same key in $extraFilters is overwritten and cannot override visibility. The front end must never list an inactive or unpublished article, not even by mistake of the calling component.

On this page

Search results