ePages 7.38.0 - 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
InstallStoreTypeConf
InstallStoreTypeDirFromBase
RelinkStoreTypeDirs
DeleteObsoleteStoreTypeConfig

Functions

DeleteObsoleteStoreTypeConfig
InstallStore
InstallStoreTypeConf
InstallStoreTypeDir
InstallStoreTypeDirFromBase
RelinkStoreTypeDirs
TestInstallStore
TestUninstallStore
UninstallStore
UninstallStoreTypeDir

DeleteObsoleteStoreTypeConfig

Deletes all directories but $Version/ in $ENV{EPAGES_CONFIG}/StoreTypes.d/

Syntax
DeleteObsoleteStoreTypeConfig($Version);
Input
$Version (string)
epages version

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

InstallStoreTypeConf

Creates $ENV{EPAGES_CONFIG}/StoreTypes.d/$Version/$StoreType.conf (extended by $MoreCartridges) from $SourceConf. $SourceConf is typically: $ENV{EPAGES_PATCHES}/patch_x_y_z_a/ExtractedDataPacks/ExtractedWebRootPacks.v /$Version/x.y.z/Config.d/base_store_type.conf

Syntax
InstallStoreTypeConf($StoreType, $Version, $SourceConf, $MoreCartridges);
Input
$StoreType (string)
store type name
$Version (string)
epages version
$SourceConf (string)
file to be copied
$MoreCartridges (ref.array)
(optional) more cartridges to add to target file

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

InstallStoreTypeDirFromBase

Creates $ENV{EPAGES_WEBROOT}/StoreTypes/$Version/$StoreType (extended by $MoreCartridges) from $SourceDir. $SourceDir is typically: $ENV{EPAGES_PATCHES}/patch_x_y_z_a/ExtractedDataPacks/ExtractedWebRootPacks.v /$Version/x.y.z/base_store_type

Syntax
InstallStoreTypeDirFromBase($StoreType, $Version, $SourceDir, $MoreCartridges);
Input
$StoreType (string)
store type name
$Version (string)
epages version
$SourceDir (string)
directory to be copied
$MoreCartridges (ref.array)
(optional) more cartridges to add to target dir

RelinkStoreTypeDirs

Deletes all directories less than $Version/ in $ENV{EPAGES_WEBROOT}/StoreTypes/ and symlinks deleted directories to $Version.

Syntax
RelinkStoreTypeDirs($Version);
Input
$Version (string)
epages version

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