Overview of methods and properties

Methods to instantiate report class

data Describe data input

group Declare a group to monitor changes between data rows

aggregate Declare variable to provide aggregate functons (sum, count, min, max)

sheet Declare variable to be aggregated horizontally (having key and value)

Methods for data handling

run Start execution with data

runPartial Iterate over a set of data

next Take a single data row

end Finalize execution

Action methods called from report class

init First called method to initiialize application

close Last called method to clean up the dishes independent from __destruct method.

totalHeader Called once after init() to build the total header page of the report.

totalFooter Called once before close() to build the total footer page of the report.

groupHeader Called for each new group value(s)

groupFooter Called after detail() but before activating new group value(s).

detail Called for each data row in last data dimension.

noData Called when no data was given.

noData_n Called when no data was given for dimension ‘n’.

noGroupChange_n Called when groups for dimension ‘n’ are declared but row didn’t trigger a group change.

Methods returning information

getRow Get the active row for the requested dimension.

getRowKey Get the key of active row for the requested dimension.

getGroupNames Get names for all declared groups.

getGroupName Get name for a requested or current group level.

getGroupValues Get current values for all declared groups.

getGroupValue Get current value for the requested or current group.

getLevel Get the current group level or the level associated with the group name.

getChangedLevel Get the level which triggered the group change.

getDimID Get the dimension id related to a group level or the current dimension id.

isFirst Bool if the action for the current or given level called the first time.

isLast Bool if the action for the current or given level called the last time.

Public Properties

$out

Output object holding the output

$gc

Group count collector

$rc

Row count collector

$total

Collector for calculators, sheets and collectors

$userConfig

Configuration parameter given during instantiation

Prototyping methods

prototype Call prototype method realted to current action. setCallAction Alter targets for actions to be executed.