CoolCMS API

ReferenceList extends BaseComponent
in package
uses InitTrait

FinalYes

Renders the presented company's references: photo, client, year, URL and quote.

Data comes from ReferenceManager, a bridge to the narrow Api action publicList (server filter presented + public; the front end does not send companyId). The entity carries only the imageId/logoId foreign keys, so photos are loaded separately through AssetManager and rendered with the thumb / company-references variant.

Presentation scopes (filtered by the manager through entity flags):

  • Grid: reference list / portfolio (inList).
  • Featured: highlighted work, large alternating cards (featured).
  • Logos: strip of supplier / partner logos (inLogos; a reference without a logo gets a text mark from its title).
  • Filmstrip: strip of photos without captions (inList, image only).

The number of items in each section is controlled only by the admin ticking the flags; the component never truncates the list.

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
$assetManager  : AssetManager
$referenceManager  : ReferenceManager

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
renderFeatured()  : void
Highlighted work as large cards with alternating image side.
renderFilmstrip()  : void
Renders a strip of work photos without captions (the gallery section).
renderGrid()  : void
Reference list / portfolio.
renderLogos()  : void
Strip of supplier and partner logos.
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).
prepareReferences()  : void
Loads the references of the chosen scope together with their image, which may be missing because `imageId` and `logoId` are nullable.

Properties

$componentParameters

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

component parameters set by setComponentParameter()

$translatorDomain

protected string|null $translatorDomain = 'front.company.components.referenceList'

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' ][, string $scope = 'list' ]) : void
Parameters
$style : string = 'Grid'
$scope : string = 'list'

renderFeatured()

Highlighted work as large cards with alternating image side.

public renderFeatured() : void

renderFilmstrip()

Renders a strip of work photos without captions (the gallery section).

public renderFilmstrip() : void

Uses the same data scope as renderGrid(); references without an image are skipped in the template.

renderGrid()

Reference list / portfolio.

public renderGrid() : void

renderLogos()

Strip of supplier and partner logos.

public renderLogos() : void

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

prepareReferences()

Loads the references of the chosen scope together with their image, which may be missing because `imageId` and `logoId` are nullable.

private prepareReferences([string $scope = 'list' ]) : void

$scope selects the presentation subset:

  • list: reference list / portfolio (inList), the default.
  • featured: highlighted work on the home page (featured).
  • logos: strip of supplier logos (inLogos; logoId may be empty).
  • all: every public reference, no subset (backward compatibility).

logos loads logoId, every other scope loads imageId; they are two separate image channels.

Parameters
$scope : string = 'list'
On this page

Search results