CoolCMS API

OrderGiftPickerTrait

Gift picker for a row of the order gifts multiplier, like {@see GiftOfferSetPickerTrait::giftOfferSetMultiPicker()}.

Offers all available gifts regardless of availableForOrder: the server guard in OrderSnapshotBuilder::buildGifts() checks only available and validity, so the admin may assign even a gift not offered on the front end. Requires $this->giftManager.

Table of Contents

Methods

orderGiftPicker()  : PickerConfig
orderGiftName()  : string
resolveOrderGiftLabel()  : string|null
suggestOrderGifts()  : array<int, array{id: int, label: string}>

Methods

orderGiftPicker()

protected orderGiftPicker([string $container = 'gifts' ][, string $targetField = 'giftId' ][, string $displayField = 'giftName' ][, string $formName = 'editForm' ]) : PickerConfig
Parameters
$container : string = 'gifts'
$targetField : string = 'giftId'
$displayField : string = 'giftName'
$formName : string = 'editForm'
Return values
PickerConfig

resolveOrderGiftLabel()

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

suggestOrderGifts()

private suggestOrderGifts(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