CoolCMS API

AdvertPickerTrait

Advert picker — the "many objects pick Advert" pattern (an advert place picks adverts).

Label = advert name (Advert.name, untranslated). Requires $this->advertManager.

Table of Contents

Methods

addAdvertControls()  : void
advertPicker()  : PickerConfig
resolveAdvertLabel()  : string|null
suggestAdverts()  : array<int, array{id: int, label: string}>

Methods

addAdvertControls()

protected addAdvertControls(Container $parent[, string $targetField = 'advertId' ][, string $displayField = 'advert' ]) : void
Parameters
$parent : Container
$targetField : string = 'advertId'
$displayField : string = 'advert'

advertPicker()

protected advertPicker([string $formName = 'editForm' ][, string|null $container = 'adverts' ][, string $targetField = 'advertId' ][, string $displayField = 'advert' ]) : PickerConfig
Parameters
$formName : string = 'editForm'
$container : string|null = 'adverts'
$targetField : string = 'advertId'
$displayField : string = 'advert'
Return values
PickerConfig

resolveAdvertLabel()

private resolveAdvertLabel(int $id) : string|null
Parameters
$id : int
Return values
string|null

suggestAdverts()

private suggestAdverts(string $query) : array<int, array{id: int, label: string}>
Parameters
$query : string
Return values
array<int, array{id: int, label: string}>
On this page

Search results