Package DE_EPAGES::XML::API::XMLInstaller
Adds dependencies functions for cartridge installer via Dependencies.xml file at each cartridge Database/XML directory. Adds patch functions for cartridge installer via patch.xml file at each cartridge Patches/Patch_xx_xx directory.
Base |
DE_EPAGES::Core::API::FileInstaller |
Functions
- directRequiredCartridges
- importPatch
- importPatchDir
- patchLanguages
- patchXMLByFunctionName
- requiredCartridgeComment
- supportedVersions
- xmlDirectory
directRequiredCartridges
Returns a list of all cartridges that are directly required by this cartridges. The list is created from the Dependencies.xml file. The list does not include indirectly required cartridges.
Syntax |
$aRequiredCartridges = $Installer->directRequiredCartridges; |
Return |
|
importPatch
processes patch.xml via xml import DE_EPAGES::XML::API::XML::PatchImportHandler::importXML
Syntax |
$NewVersion = $Installer->importPatch($PatchXMLFile, $PatchSection); |
Example |
my $FunctionName = GetCallerFunction(); my $PatchXMLFile = $self->patchXMLByFunctionName($FunctionName); $self->importPatch($PatchXMLFile, 'PatchDBStructure'); $self->importPatch($PatchXMLFile, 'Patch'); |
Input |
|
Return |
|
importPatchDir
Processes the file patch.xml in the directory Patches/$PatchSubDir if it exists.
Syntax |
$NewVersion = $Installer->importPatchDir($PatchSubDir, $PatchSection); |
Example |
$NewVersion = $self->importPatchDir('Patch_6_9_0', 'Patch'); |
Input |
|
Return |
|
patchLanguages
Processes all existing files patch.*.xml in the directory Patches/$PatchSubDir.
Syntax |
$Installer->patchLanguages($PatchSubDir, $PatchSection); |
Example |
$self->patchLanguages('Patch_6_9_0', 'PatchCartridgeDir'); |
Input |
|
patchXMLByFunctionName
Returns FileName to the patch.xml in the correct patch directory e.g. 'C:\epages\Cartridges\DE_EPAGES\Cartridge\Patches\Patch_1_0\patch.xml'. this should be used by importPatch
Syntax |
$PatchXMLFile = $Installer->patchXMLByFunctionName($FunctionName); |
Example |
my $FunctionName = GetCallerFunction(); my $PatchXMLFile = $self->patchXMLByFunctionName($FunctionName); $self->importPatch($PatchXMLFile, 'Patch'); |
Input |
|
Return |
|
requiredCartridgeComment
Returns a verbal description about why the cartridge is required.
Syntax |
$Comment = $Installer->requiredCartridgeComment( $Package ); |
Example |
$Comment = $Installer->requiredCartridgeComment( 'DE_EPAGES::Object' ); |
Input |
|
Return |
|
supportedVersions
Returns versions of package which are supported. If no versions are returned, all versions supported.
Syntax |
$Versions = $Installer->supportedVersions($Package); |
Input |
|
Return |
|
xmlDirectory
Returns xml install/uninstall directory.
Syntax |
$Directory = $Installer->xmlDirectory; |
Return |
|