ePages 6.12.0 - DE_EPAGES/ShopConfiguration/API/StoreCartridge.pm

Package DE_EPAGES::ShopConfiguration::API::StoreCartridge

This package provides helper functions for database - cartridge assigment.

@EXPORT_OK
SyncStoreCartridges
IsStoreCartridgeRegistered
GetStoreCartridgeVersion
SetStoreCartridges

Functions

GetStoreCartridgeVersion
IsStoreCartridgeRegistered
SetStoreCartridges
SyncStoreCartridges

GetStoreCartridgeVersion

Returns the version of the cartridge installed in the store. Returns undef if the cartridge is not installed. Use SyncStoreCartridges to update the cartridge versions.

Syntax
$Version = GetStoreCartridgeVersion( $Store, $Package );
Input
$Store (object)
store / database
$Package (string)
cartridge package name
Return
$Version (string)
cartridge version

IsStoreCartridgeRegistered

Test is cartridge is registered on Store. Use SyncStoreCartridges to update the list.

Syntax
$IsRegistered = IsStoreCartridgeRegistered( $Store, $Package );
Input
$Store (object)
store / database
$Package (string)
cartridge package name
Return
$IsRegistered (boolean)
true if cartridge is registered for the store

SetStoreCartridges

updates the list of cartridges in the Site database.

Syntax
SetStoreCartridges($Store, $aCartridges);
Input
$Store (object)
store / database
$aCartridges (ref.array.hashes)
an array with cartridge objects

SyncStoreCartridges

Gets the list of installed cartridges in the store database using a web service. Then updates the list of cartridges in the Site database.

Syntax
SyncStoreCartridges( $Store );
Input
$Store (object)
store / database