CoolCMS API

LastGallery extends BaseComponent
in package

Latest published blog gallery: a strip of photos for the home page.

Renders through frontSystemGallery (the STYLE_* constants of Gallery); this component only picks the gallery and passes its assets.

NOTE: galleries with only_for_logged are skipped. This is not authorization (the detail page handles that), only consideration for content: a public home page should not show a strip that half of the visitors cannot reach.

NOTE: asset files are per machine (production, dev and local share only the database), so a missing photo renders as a placeholder image, not as a hole; see AssetPlaceholderHelper.

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
$galleryManager  : GalleryManager

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
renderCarousel()  : void
renderFilmstrip()  : void
renderGrid()  : void
renderMasonry()  : void
renderMosaic()  : 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).
findGallery()  : Gallery|null
Gallery to render: the one with the given id, otherwise the latest published.

Properties

$componentParameters

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

component parameters set by setComponentParameter()

$translatorDomain

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

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 = 'Grid' ][, int $maxAssets = 8 ][, int|null $galleryId = null ]) : void
Parameters
$style : string = 'Grid'

gallery render style (Grid, Masonry, Mosaic, Filmstrip, ...)

$maxAssets : int = 8

maximum number of photos shown; the rest is summed into "+ N more"

$galleryId : int|null = null

specific gallery; null means the latest published one

renderCarousel()

public renderCarousel([int $maxAssets = 8 ][, int|null $galleryId = null ]) : void
Parameters
$maxAssets : int = 8
$galleryId : int|null = null

renderFilmstrip()

public renderFilmstrip([int $maxAssets = 8 ][, int|null $galleryId = null ]) : void
Parameters
$maxAssets : int = 8
$galleryId : int|null = null

renderGrid()

public renderGrid([int $maxAssets = 8 ][, int|null $galleryId = null ]) : void
Parameters
$maxAssets : int = 8
$galleryId : int|null = null

renderMasonry()

public renderMasonry([int $maxAssets = 8 ][, int|null $galleryId = null ]) : void
Parameters
$maxAssets : int = 8
$galleryId : int|null = null

renderMosaic()

public renderMosaic([int $maxAssets = 8 ][, int|null $galleryId = null ]) : void
Parameters
$maxAssets : int = 8
$galleryId : int|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

findGallery()

Gallery to render: the one with the given id, otherwise the latest published.

private findGallery(int|null $galleryId) : Gallery|null
Parameters
$galleryId : int|null
Return values
Gallery|null
On this page

Search results