CoolCMS API

FavouriteTrait

Favourite adverts — storage is the session, which holds nothing but an array of `advertId`.

Focused trait: only handle* signals + their processing. The shared finish (style, redraw, flash) is delegated to ToggleRedrawTrait::finishToggle().

Table of Contents

Properties

$favouriteSessionSection  : string

Methods

getFavouriteIds()  : array<string|int, int>
handleAddToFavourites()  : void
handleDelFromFavourites()  : void
initFavourites()  : void
isInFavourites()  : bool
getFavouriteSection()  : SessionSection

Properties

$favouriteSessionSection

private string $favouriteSessionSection = ''

Methods

getFavouriteIds()

public getFavouriteIds() : array<string|int, int>
Return values
array<string|int, int>

handleAddToFavourites()

public handleAddToFavourites(int $advertId[, string $style = 'Style_1' ]) : void
Parameters
$advertId : int
$style : string = 'Style_1'

handleDelFromFavourites()

public handleDelFromFavourites(int $advertId[, string $style = 'Style_1' ]) : void
Parameters
$advertId : int
$style : string = 'Style_1'

initFavourites()

public initFavourites(string $sessionSection) : void
Parameters
$sessionSection : string

isInFavourites()

public isInFavourites(int $advertId) : bool
Parameters
$advertId : int
Return values
bool

getFavouriteSection()

private getFavouriteSection() : SessionSection
Return values
SessionSection
On this page

Search results