CoolCMS API

ServiceList extends BaseComponent
in package
uses InitTrait

FinalYes

Renders the presented company's price list grouped by service group.

An item has a name, description, price (optionally "from") and unit; a null price means "by agreement". Data comes from ServiceManager::findPublicServices(), a bridge to the narrow Api action publicList (server filter presented + public + activated; the front end does not send companyId). The entity carries only the imageId foreign key, so group photos are loaded separately through AssetManager.

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
$serviceManager  : ServiceManager

Methods

__call()  : mixed
Dispatches `renderXyz()` to `render('Xyz', ...$args)`.
__construct()  : mixed
createComponent()  : IComponent|null
formatPrice()  : string|null
Formats a price without a currency symbol.
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
renderCards()  : void
Home page cards, one card per price-list group (coarser than the item list).
renderCarousel()  : void
Renders the service cards as a carousel (`.list--carousel`).
renderLinks()  : void
Plain list of group names, used for the services column in the footer.
renderList()  : void
Price list by group, one row per priced item.
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
attachGroupImages()  : void
Loads group photos (`imageId` to `Asset`, may be missing) into the `image` key.
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).
prepareGroups()  : void
Builds the group-to-items structure by `serviceGroupId`.

Properties

$componentParameters

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

component parameters set by setComponentParameter()

$translatorDomain

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

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

formatPrice()

Formats a price without a currency symbol.

public formatPrice(string|null $price) : string|null

The currency belongs to the company, not to the item, and resolving the company's currencyId is outside this component. A whole number has no decimals, otherwise two; a space separates thousands.

Parameters
$price : string|null
Return values
string|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 = 'List' ]) : void
Parameters
$style : string = 'List'

renderCards()

Home page cards, one card per price-list group (coarser than the item list).

public renderCards() : void

renderCarousel()

Renders the service cards as a carousel (`.list--carousel`).

public renderCarousel() : void

Same content as renderCards() plus track, arrows and dots. It is a separate method because template2 uses a static grid that a carousel would break.

renderLinks()

Plain list of group names, used for the services column in the footer.

public renderLinks() : void

renderList()

Price list by group, one row per priced item.

public renderList() : 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

attachGroupImages()

Loads group photos (`imageId` to `Asset`, may be missing) into the `image` key.

private attachGroupImages(array<int, Service>}> &$groups) : void

The entity carries only the foreign key. One IN query covers all filtered groups.

Parameters
$groups : array<int, Service>}>

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

prepareGroups()

Builds the group-to-items structure by `serviceGroupId`.

private prepareGroups() : void

Service has no ORM association to ServiceGroup (see ServicePresenter::internalActionPublicList()). Groups and items arrive from the Api already sorted by their own order; they are only joined here. An empty group (all items filtered out by the server as non-public) is not rendered, because a heading without items would be confusing.

On this page

Search results