ePages 6.13.1 - DE_EPAGES/MultiStoreProvider/API/ShopRef.pm

Package DE_EPAGES::MultiStoreProvider::API::ShopRef

MultiStore shop assignment API

Base
Base
@EXPORT_OK
AssignSubShopToMasterShop
UnassignSubShopFromMasterShop
IsSubShopAssignedToMasterShop
UnassignAllSubShops
SearchShopRefByAlias
UpdateRemoteSubShop
GetCacheShopInfoByStore

Functions

AssignSubShopToMasterShop
GetCacheShopInfoByStore
IsSubShopAssignedToMasterShop
SearchShopRefByAlias
UnassignAllSubShops
UnassignSubShopFromMasterShop
UpdateRemoteSubShop

AssignSubShopToMasterShop

Adds subshop / mastershop assignment

Syntax
AssignSubShopToMasterShop( $MasterShopRef, $SubShopRef );
Input
$MasterShopRef (DE_EPAGES::ShopConfiguration::API::Object::ShopRef)
mastershop
$SubShopRef (DE_EPAGES::ShopConfiguration::API::Object::ShopRef)
subshop
$UpdateRemoteShop (boolean)
set to true if you want to update the subshop
Return
$MasterToSubShopRefMapper (DE_EPAGES::MultiStoreProvider::API::Object::MasterToSubShopRefMapper)
mapper object

GetCacheShopInfoByStore

Returns a list of cache shops in given store

Syntax
GetCacheShopInfoByStore( $Store );
Input
$Store (object)
store
Return
$aCacheShops (ref.hash.string)
cache shop list. used keys:
  • MasterShopAlias - mastershop - string
  • CacheShop - objectid of cacheshop - integer

IsSubShopAssignedToMasterShop

Checks subshop / mastershop assignment

Syntax
IsSubShopAssignedToMasterShop( $MasterShopRef, $SubShopRef );
Input
$MasterShopRef (DE_EPAGES::ShopConfiguration::API::Object::ShopRef)
mastershop
$SubShopRef (DE_EPAGES::ShopConfiguration::API::Object::ShopRef)
subshop
Return
$IsAssigned (boolean)
true if subshop is assigned to mastershop

SearchShopRefByAlias

Search shopref by alias

Syntax
SearchShopRefByAlias( $ShopAlias );
Input
$ShopAlias (string)
shop alias
Return
$ShopRef (object)
shop ref

UnassignAllSubShops

Deletes all subshop assignments from mastershop

Syntax
UnassignAllSubShops( $MasterShopRef );
Input
$MasterShopRef (DE_EPAGES::ShopConfiguration::API::Object::ShopRef)
Mastershop

UnassignSubShopFromMasterShop

Removes subshop / mastershop assignment

Syntax
UnassignSubShopFromMasterShop( $SubShopRef );
Input
$SubShopRef (DE_EPAGES::ShopConfiguration::API::Object::ShopRef)
subshop

UpdateRemoteSubShop

sets attribute in remote SubShop

Syntax
UpdateRemoteSubShop( $ShopRef, $hValues );
Input
$ShopRef (object)
shop ref
$hValues (ref.hash.string)
attributes to set