\CGExtensions\reportstabular_report_defn_group

A class to define a grouping within a tabular report.

Groups can create multiple header and footer lines to display labels or calculated values. Each column inside a group can display a different value (such as a count, min/max/average/mean/sum) of grouped values.

Summary

Methods
Properties
Constants
__construct()
get_column()
set_column()
get_header_lines()
add_header_line()
get_footer_lines()
add_footer_line()
set_after_action()
get_after_action()
set_before_action()
get_before_action()
No public properties found
ACT_PAGE
ACT_LINE
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Constants

ACT_PAGE

ACT_PAGE

ACT_LINE

ACT_LINE

Methods

__construct()

__construct(string $col)

Construct a new group definition.

Parameters

string $col

The column that this group is based on (This column will be tracked for changes in value). The column must be defined in the report definition.

get_column()

get_column() : string

Get the column that this group watches.

Returns

string

set_column()

set_column(string $str)

Set the column that this group watches.

Parameters

string $str

The column name (the column must be defined in the report definition).

get_header_lines()

get_header_lines() : \CGExtensions\reports\tabular_report_defn_group_line[]

Get the header lines for this report.

Returns

\CGExtensions\reports\tabular_report_defn_group_line[]

get_footer_lines()

get_footer_lines() : \CGExtensions\reports\tabular_report_defn_group_line[]

Get the footer lines for this report.

Returns

\CGExtensions\reports\tabular_report_defn_group_line[]

set_after_action()

set_after_action(string $tmp)

Set an action to perform after group footers are output (if any).

Some generators (for example PDF) may be able to do certain actions like generate a new page after the group. This flag indicates the preferred behavior for this group.

Parameters

string $tmp

The behavior. There are constants for this behavior defined in this class. unknown values will be ignored.

get_after_action()

get_after_action() : string

Get the preferred action to perform after group footers are output (if any)

Returns

string

set_before_action()

set_before_action(string $tmp)

Set an action to perform before group headers are output (if any).

Some generators (for example PDF) may be able to do certain actions like generate a new page after the group. This flag indicates the preferred behavior for this group.

Parameters

string $tmp

The behavior. There are constants for this behavior defined in this class. unknown values will be ignored.

get_before_action()

get_before_action() : string

Get the preferred action to perform before group headers are output (if any)

Returns

string