get_resultset()
get_resultset() : \CGExtensions\query\resultset&
Get the resultset object that will be used to provide data for this report.
Returns
\CGExtensions\query\resultset& —The resultset object
This class is used for reports that generate tabular data (which is most types of financial reports, etc.).
This class supports grouping, and group operations like min, max, sum, average etc.
define_column(\CGExtensions\reports\tabular_report_defn_column $col)
Define a column for the tabular report.
This defines the major columns for the report, and includes formatting information. The columns defined must match those returned by the resultset object (or you must define a function for doing value processing).
\CGExtensions\reports\tabular_report_defn_column | $col |
get_columns() : \CGExtensions\reports\tabular_report_defn_column[]
Get the columns defined for this report in order by their weigint, or their key.
If a sorting value is specified for any column then all columns are sorted by the sorting value and then the label. otherwise the order in which they are added is retained.
get_column(string $key) : \CGExtensions\reports\tabular_report_defn_column|null
Get the column specified by the column name.
string | $key |
add_group(\CGExtensions\reports\tabular_report_defn_group $grp)
Add a grouping to this report.
Groupings allow header and footer lines, and mathematic on the values displayed within that group.
\CGExtensions\reports\tabular_report_defn_group | $grp | The group object. |
get_report_group() : \CGExtensions\reports\tabular_report_defn_group|null
Get the report group for this report (if there is one).
set_query(\CGExtensions\query\query $query)
Set the query that will be used for this report.
\CGExtensions\query\query | $query | The query object |