ePages 6.17.52 - DE_EPAGES/Diagnostics/API/Diagnostics.pm

Package DE_EPAGES::Diagnostics::API::Diagnostics

subs to get cartridge information (before in /UI/Cartridge.pm)

@EXPORT_OK
HashCartrigde
DependenciesLoop
CartridgesLoop
CartridgeVars

Functions

CartridgeVars
CartridgesLoop
ClassesLoop
DependenciesLoop
DependendCartridgesLoop
HashCartrigde
InstallerCartridgeVars
ModelsLoop
PatchesLoop

CartridgeVars

Returns all information of a cartridge like dependencies, classes, ...

Syntax
$hCartridgeVars = CartridgeVars( $hCartridge );
Input
$hCartridge (ref.hash)
result of the public function HashCartridge.
Return
$hCartridgeVars (ref.hash)
cartridge information

CartridgesLoop

Returns all Cartridges and their version

Syntax
$hCartridges = CartridgesLoop();
Return
$hCartridges (ref.hash)
key: cartridge name, value: version

ClassesLoop

Returns classes and information

Syntax
$aClasses = ClassesLoop( $Package );
Input
$Package (string)
package name
Return
$aClasses (ref.array)
classes and info

DependenciesLoop

Gets all dependencies and thei info from a cartridge hash

Syntax
$aRequiredCartridges = DependenciesLoop( $hCartridge );
Input
$hCartridge (ref.hash)
result of the function Hashcartridge.
Return
$aRequiredCartridges (ref.array)
Dependencies

DependendCartridgesLoop

Returns the dependend cartridges.

Syntax
DependendCartridgesLoop( $hCartridge );
Input
$hCartridge (ref.hash)
result of the public function HashCartridge
Return
$aClasses (ref.array)
dependend cartridges and some info

HashCartrigde

Builds a hash with the cartridge information

Syntax
$hCartridge = HashCartrigde( $Package );
Input
$Package (string)
package (cartridge) name
Return
$hCartridge (ref.hash)
cartridge information

InstallerCartridgeVars

Returns InstallerCartridgeVars

Syntax
$InstallerCartrigeVars = InstallerCartridgeVars( $Installer );
Input
$Installer (ref.hash)
Hash with installer information
Return
$InstallerCartrigeVars (ref.hash)
information of the installer

ModelsLoop

Returns models of a cartridge

Syntax
$aModels = ModelsLoop( $cartridgeName, $DocRoot );
Input
$cartridgeName (string)
cartridge name
$DocRoot (string)
path to the root of the doc folder.
Return
$aModels (ref.array)
models and info

PatchesLoop

Gets all patches from a cartridge hash

Syntax
$aPatches = PatchesLoop( $hCartridge );
Input
$hCartridge (ref.hash)
result of the function Hashcartridge
Return
$aPatches (ref.array)
patch versions