ePages 6.13.3 - DE_EPAGES/XML/API/XML/CartridgeInstallerImportHandler.pm

Package DE_EPAGES::XML::API::XML::CartridgeInstallerImportHandler

Parses the Cartridges.xml file.

Example
use DE_EPAGES::CartridgeInstaller::API::XML::CartridgeInstallersImportHandler qw( GetStoreTypeCartridges );
my $aCartridges = GetStoreTypeCartridges('Store ');
@EXPORT_OK
UpdateCartridgesXml
GetCartridges
GetStoreTypeCartridges

Functions

GetCartridges
GetStoreTypeCartridges
UpdateCartridgesXml

GetCartridges

Imports the Cartriges.xml file and returns the list of cartridges for each database type.

Syntax
$hDatabaseTypes = GetCartridges( $FileName );
Input
$FileName (string)
XML file name (optional, default: $ENV{'EPAGES_CARTRIDGES'}.'/Cartridges.xml')
$hFlags (hash ref)
flags to modify the behaviour of GetCartridges. The following flags
can be used:
  • nobase - do not add Base entries to database type entries

Return
$hDatabaseTypes (ref.hash.array)
list of cartridges for all database types.
Keys are database type names, such as 'Site', 'Store' etc..
Values are a list of cartridge packages, for example:
['DE_EPAGES::Core', 'DE_EPAGES::Database', ...]

GetStoreTypeCartridges

Returns the list of cartridges of the database type.

Syntax
$aCartridges = GetStoreTypeCartridges( $StoreType );
$aCartridges = GetStoreTypeCartridges( $StoreType, $FileName );
Input
$StoreType (string)
database type name, e.g. 'Store' or 'Site'
$FileName (string)
XML file name (optional, default: $ENV{'EPAGES_CARTRIDGES'}.'/Cartridges.xml')
Return
$aCartridges (ref.array.string)
list of cartridges of the database type

UpdateCartridgesXml

In $CartridgesDir, changes Cartridges.xml as defined in $CartridgesXmlChanges, then sorts Cartridges.xml by Dependencies.xml.

Syntax
UpdateCartridgesXml($CartridgesDir, $CartridgesXmlChanges)
Input
$CartridgesDir (string, optional)
Cartridges directory (default: $ENV{EPAGES_CARTRIDGES})
$CartridgesXmlChanges (string, optional)
Ini file as defd in https://jira.epages.de/browse/EPG-19354