FavouriteHandlerTrait
Table of Contents
Properties
- $favouriteSessionSection : string
- $favouriteSnippets : array<int, string>
Methods
- addFavouriteSnippets() : void
- getFavouriteSnippets() : array<int, string>
- handleAddToFavourites() : void
- handleDelFromFavourites() : void
- initFavourites() : void
- setFavouritesForTemplate() : void
- setFavouriteSnippets() : void
- getFavouriteIds() : array<int, int>
- getFavouriteSessionStorage() : Session
- Returns the session that holds the favourites; a presenter returns `getSession()`, a component the injected service.
- getFavouriteSection() : SessionSection
- isEntityInFavourites() : bool
Properties
$favouriteSessionSection
private
string
$favouriteSessionSection
$favouriteSnippets
private
array<int, string>
$favouriteSnippets
= ['favouriteLinksSnippet', 'flashMessagesSnippet']
Methods
addFavouriteSnippets()
public
addFavouriteSnippets(array<int, string> $snippets) : void
Parameters
- $snippets : array<int, string>
getFavouriteSnippets()
public
getFavouriteSnippets() : array<int, string>
Return values
array<int, string>handleAddToFavourites()
public
handleAddToFavourites(int $entityId[, string $style = 'Style_1' ]) : void
Parameters
- $entityId : int
- $style : string = 'Style_1'
handleDelFromFavourites()
public
handleDelFromFavourites(int $entityId[, string $style = 'Style_1' ]) : void
Parameters
- $entityId : int
- $style : string = 'Style_1'
initFavourites()
public
initFavourites(string $sessionSection) : void
Parameters
- $sessionSection : string
setFavouritesForTemplate()
public
setFavouritesForTemplate(int $id) : void
Parameters
- $id : int
setFavouriteSnippets()
public
setFavouriteSnippets(array<int, string> $snippets) : void
Parameters
- $snippets : array<int, string>
getFavouriteIds()
protected
getFavouriteIds() : array<int, int>
Return values
array<int, int>getFavouriteSessionStorage()
Returns the session that holds the favourites; a presenter returns `getSession()`, a component the injected service.
protected
abstract getFavouriteSessionStorage() : Session
Return values
SessiongetFavouriteSection()
private
getFavouriteSection() : SessionSection
Return values
SessionSectionisEntityInFavourites()
private
isEntityInFavourites(int $entityId) : bool
Parameters
- $entityId : int