ePages 7.0.0 - DE_EPAGES/GuidedTour/API/TLE/GuidedTourHandler.pm

Package DE_EPAGES::GuidedTour::API::TLE::GuidedTourHandler

Guided Tour handler

Functions

UnityBuildTourURL
UnityCreateTourForShop
UnityGetActiveTourForPage
UnityGetAllActiveToursForShopType
createTourForShop
getActiveTour
getActiveTours
getGuidedTourShopFolder
getShopTour
getViewActionAlias
getViewActionObjectID

UnityBuildTourURL

builds the url to jump to the given tour

Syntax
UnityBuildTourURL($Processor, $aParams)
Input
$Processor (object)
tle processor
$aParams (ref.hash)
params
Return
$TourURL (string)
url to tour

UnityCreateTourForShop

Creates or gets the database object for a shop and returns it

Syntax
UnityCreateTourForShop($Processor, $aParams)
Input
$Processor (object)
tle processor
$aParams (ref.hash)
params
Return
$ShopTour (object)
shop tour object

UnityGetActiveTourForPage

Return one active tour that is available for the given shop type and page type.

Syntax
UnityGetActiveTourForPage($Processor, $aParams)
Input
$Processor (object)
tle processor
$aParams (ref.array)
params
Return
$hTour (ref.hash)
tour

UnityGetAllActiveToursForShopType

Return all active tours

Syntax
UnityGetAllActiveToursForShopType($Processor, $aParams)
Input
$Processor (object)
tle processor
Return
$hTour (ref.hash)
tour

createTourForShop

Creates a tour object for a shop.

Syntax
createTourForShop($Shop, $Tour);
Input
$Shop (object)
shop in which the tour will be created
$hTourConfig (ref.hash)
params
Return
$ShopTour (object)
shop tour

getActiveTour

Returns one active tour from $aAvailableTours that corresponds to the given shop type and page type.

Syntax
getActiveTour($ShopTypeAlias, $PageTypeAlias, $aAvailableTours)
Input
$aAvailableTours (ref.array)
array of all available guided tours
$hParams (ref.hash)
hook arguments keys :
  • ShopTypeAlias - shop type alias - string
  • PageTypeAlias - pagetype alias - string
  • Processor - tle processor - object
Return
$hTour (ref.hash)
tour

getActiveTours

Returns all active tours from $aAvailableTours that corresponds to the given shop type and page type.

Syntax
getActiveTours($ShopTypeAlias, $PageTypeAlias, $aAvailableTours)
Input
$aAvailableTours (ref.array)
array of all available guided tours
$hParams (ref.hash)
hook arguments keys :
  • ShopTypeAlias - shop type alias - string
  • PageTypeAlias - pagetype alias - string
  • Processor - tle processor - object
Return
$ahTours (ref.hash)
tours

getGuidedTourShopFolder

returns the guided tours folder for shop

Syntax
getGuidedTourShopFolder($Shop)
Input
$Shop (object)
shop
Return
$GuidedTourFolder (object)
guided tour folder

getShopTour

loads the tourobject in the shop

Syntax
getShopTour($Shop, $TourAlias)
Input
$Shop (object)
shop
$TourAlias (ref.hash)
tour alias from shop
Return
$ShopTour (object)
shop tour

getViewActionAlias

gets the viewaction alias for the a given pagetype

Syntax
getViewActionAlias($PageTypeAlias)
Input
$PageTypeAlias (string)
pagetype alias
Return
$ViewActionAlias (string)
viewaction alias

getViewActionObjectID

loads the object for the shop and returns the id

Syntax
getViewActionObjectID($Shop, $ViewActionObjectAlias)
Input
$Shop (object)
shop
$ViewActionObjectAlias (string)
object alias for viewactions of tour
Return
$ObjectId (int)
tour id