ePages 7.28.0 - DE_EPAGES/GuidedTour/API/Object/UnityMBOGuidedTourConfig.pm

Package DE_EPAGES::GuidedTour::API::Object::UnityMBOGuidedTourConfig

Functions

additionalCriteria
className
ensurePreConditions
getAssignedPageTypes
getAssignedShopType
getExcludedShopType
isActive
isCorrectPageType
isCorrectShopType

additionalCriteria

checks if a specific tour is active for some given parameter

Syntax
additionalCriteria
Input
$hParams (ref.hash)
hook arguments keys :
  • ShopTypeAlias - shop type alias - string
  • PageTypeAlias - pagetype alias - string
  • Processor - tle processor - object
Return
$isAcvtive (boolean)
tour si active for shop

className

Returns the class name, used for DAL access.

Syntax
$ClassName = UnityMBOGuidedTourConfig->className;
Return
$ClassName (String)
class name

ensurePreConditions

ensures the precondiions for a tour

Syntax
ensurePreConditions
Input
$Shop (object)
shop
$User (object)
user

getAssignedPageTypes

gives back assigned pagetypes

Syntax
getAssignedPageTypes
Return
$assignedPageTypes (string)
assigned pagetypes

getAssignedShopType

gives back assigned shoptypes

Syntax
getAssignedShopType
Return
$assignedShopTypes (string)
assigned shoptypes

getExcludedShopType

gives back excludedShopTypes shoptypes

Syntax
getExcludedShopType
Return
$excludedShopTypes (string)
excludedShopTypes shoptypes

isActive

checks if a tour is active for some given parameters

Syntax
isActive()
Input
$hParams (ref.hash)
hook arguments keys :
  • ShopTypeAlias - shop type alias - string
  • PageTypeAlias - pagetype alias - string
  • Processor - tle processor - object
Return
$isAcvtive (boolean)
tour si active for shop

isCorrectPageType

Checks if the shoptype for the guideded tour is allowed

Syntax
isCorrectPageType()
Input
$PageTypeAlias (string)
PageTypeAlias
Return
$allowed (ref.array)
shoptype contains tour

isCorrectShopType

Checks if the shoptype for the guideded tour is allowed

Syntax
isCorrectShopType()
Input
$shopTypeAlias (string)
shopTypeAlias
Return
$allowed (ref.array)
shoptype contains tour