ePages 6.15.1 - DE_EPAGES/Installer/API/Install.pm

Package DE_EPAGES::Installer::API::Install

API functions for installing and uninstalling cartridges.

@EXPORT_OK
TestInstallStore
InstallStore
InstallStoreTypeDir
TestUninstallStore
UninstallStore
UninstallStoreTypeDir

Functions

InstallStore
InstallStoreTypeDir
TestInstallStore
TestUninstallStore
UninstallStore
UninstallStoreTypeDir

InstallStore

Installs cartridges into the active database (no tests).

Syntax
InstallStore($aPackages, $hOptions);
Example
InstallStore(['DE_EPAGES::WorldPay'], $hOptions);
Input
$aPackages (ref.array.string)
install these cartriges
$hOptions (ref.hash.string)
additional parameters for the cartridge constructor

InstallStoreTypeDir

Installs the store type directory for the given store type.

Syntax
InstallStoreTypeDir($StoreType, $aPackages, $Version, $hOptions);
Input
$StoreType (string)
store type name
$aPackages (ref.array.string)
test these packages
$Version (string)
epages version
$hOptions (ref.hash.string)
(optional) additional parameters for the cartridge
constructor

TestInstallStore

Tests if the given cartridges can be installed into the active database.

Syntax
$ahReasons = TestInstallStore($aPackages, $hOptions);
Input
$aPackages (ref.array.string)
test these cartriges
$hOptions (ref.hash.string)
(optional) additional parameters for the cartridge
constructor
Return
$ahReasons (ref.array.hash.string)
reasons why install is not possible

TestUninstallStore

Tests uninstall (multiple packages) in an active store.

Syntax
$ahReasons = TestUninstallStore($aPackages, $hOptions);
Input
$aPackages (ref.array.string)
test these packages
$hOptions (ref.hash.string)
(optional) additional parameters for the cartridge
constructor
Return
$ahReasons (ref.array.hash.string)
reasons why uninstall is not possible

UninstallStore

Uninstalls cartridges from the active database (no tests).

Syntax
UninstallStore($aPackages, $hOptions);
Input
$aPackages (ref.array.string)
uninstall these cartridges
$hOptions (ref.hash.string)
additional parameters for the cartridge constructor

UninstallStoreTypeDir

Uninstalls the store type directory for the given store type.

Syntax
UninstallStoreTypeDir($StoreType, $aCartridges, $Version);
Input
$ahStores (ref.array.hash.string)
store names and password keys :
  • Name - store name - string
  • DBPassword - password (optional) - string
$aPackages (ref.array.string)
test these packages
$hOptions (ref.hash.string)
(optional) additional parameters for the cartridge
constructor