Kernel::WebApp::Util::StatisticReport

NAME

Kernel::WebApp::Util::StatisticReport – Helper class for the statistics report functionality.

PUBLIC INTERFACE

has UserID

Attribute that holds the user id.

has UserData

Attribute that holds the user data.

has ID

Attribute that holds the report id.

has Data

Attribute that holds the complete report data.

has LanguageData

Attribute that holds the language data.

has AddableStatistics

Attribute that holds a list of all statistics.

has FormObject

This attribute contains the statistic form helper object.

GetFormSchema()

Builds the form schema for the requested form type ('Run', 'Widget', 'Create' and 'Update').

    $ReportUtilObject->GetFormSchema(
        FormType => '(Run|Widget|Create|Update)',
    );

Returns the requested form schema.

TransformReportStatisticConfiguration()

Transforms the given statistic configuration (added in report create / update screen) into a proper format, which can be used to store it in the report configuration.

    $ReportUtilObject->TransformReportStatisticConfiguration(
        Statistics         => { ... },
        RemoveHiddenFields => 0|1,      # For removing disabled form fields in the result data (to store only changed fields in the database)
    );

Returns an array reference containing all added statistics.

PRIVATE INTERFACE

has _SystemStatsReportObject

This attribute contains the business object.

has _SystemStatsObject

This attribute contains the business object.

has _SystemStatsUtilsObject

This attribute contains the business object.

_BuildSystemStatsReportObject()

Initializes the attribute _SystemStatsReportObject.

_BuildSystemStatsObject()

Initializes the attribute _SystemStatsObject.

_BuildSystemStatsUtilsObject()

Initializes the attribute _SystemStatsUtilsObject.

_BuildFormObject()

Initializes the attribute FormObject.

_BuildData()

Initializes the attribute Data.

_BuildAddableStatistics()

Initializes the attribute AddableStatistics.

_BuildUserData()

Initializes the attribute UserData.

_BuildLanguageData()

Initializes the attribute LanguageData.

Scroll to Top