ePages 7.21.0 - DE_EPAGES/Installer/API/SystemInfoReport/SystemInfoReportHandler.pm

Package DE_EPAGES::Installer::API::SystemInfoReport::SystemInfoReportHandler

This the install handler for all patch install functions.

@EXPORT
FileCategories
DBStructureCategories
DBContentCategories
DBXMLGeneralStoreSections
DBXMLExclusiveStoreSections
DBXMLExclusiveSiteSections

Functions

_exportFromParallelProcess
_exportSequential
exportReport

_exportFromParallelProcess

exports the report of the report sections as a called background process will ask permission to delete output folder

Syntax
$SystemInfoReportHandler->_exportFromParallelProcess( $Recursive, $OutputFolder, $aRoles, $ReportSection, $Role, $aStore );
Input
$Recursive (boolean)
this process is called recursive
$OutputFolder (string)
target folder for output
$aRoles (ref arry string)
array of all roles
$ReportSection (string)
report section
$Role (string)
role, regulate the type of output (optional)
$aStore (ref array string)
stores, regulate the type of output (optional)

_exportSequential

exports the report of the report sections sequentially in one process will ask permission to delete output folder sets standard values for role and report section if undef

Syntax
$SystemInfoReportHandler->_exportSequential( $OutputFolder, $aRoles, $aReportSections, $aStore, $Role ) ;
Input
$OutputFolder (string)
target folder for output
$aRoles (ref arry string)
array of all roles
$aReportSections (ref array string)
report sections, regulate the type of output (optional)
$aStore (ref array string)
stores, regulate the type of output (optional)
$Role (string)
role, regulate the type of output (optional)

exportReport

exports the report of the report sections will ask permission to delete output folder sets standard values for role and report section if undef is able to call background processes

Syntax
$SystemInfoReportHandler->exportReport( $OutputFolder, $Role, $aReportSections, $aStore, $SkriptDir, $Background, $Recursive );
Input
$OutputFolder (string)
target folder for output
$Role (string)
role, regulate the type of output (optional)
$aReportSections (ref array string)
report sections, regulate the type of output (optional)
$aStore (ref array string)
stores, regulate the type of output (optional)
$SkriptDir (string)
directory of getSystemInfo script
$Background (boolean)
use background processes to fetch every caregory simultaneously
$Recursive (boolean)
this process is called recursive