\cge_report_base

get_name()

get_name() : string

Return the title of this report.

Returns

get_description()

get_description() : string

Get a human readable description for this report.

Returns

generate()

generate() : string

Generate the report

Returns

get_page_count()

get_page_count() : \uint

Get the number of pages in this report If this report does not perform pagination of any sort, it can return 1

Returns

get_page_data()

get_page_data(\uint $page_number) : mixed

Get the page data for the specified page The data returned will be given to smarty as the variable 'report_data';

This abstract method should perform any grouping or data processing, but should leave the formatting up to the template.

Parameters

Returns

get_page_separator()

get_page_separator() : string

Get the page separator code used for multiple page reports to output the appropriate code to trigger a page break.

Returns

get_page_header_data()

get_page_header_data(int $pagenum) : mixed

Get page header data (if any) for the specified page number of the report.

This method is called once for each page of the report. Used for multiple page reports, the returned data (if any) will be given to smarty under the variable 'page_header_data'.

Parameters

Returns

get_page_footer_data()

get_page_footer_data(int $pagenum) : mixed

Get page footer data (if any) for the specified page number of the report.

This method is called once for each page of the report. Used for multiple page reports, the returned data (if any) will be given to smarty under the variable 'page_footer_data'.

Parameters

Returns

get_report_header_data()

get_report_header_data() : mixed

Get report header data (if any) for the specified report.

this method is only called once per report. This data will be assigned to smarty under the variable 'report_header_data'

Returns

get_report_footer_data()

get_report_footer_data() : mixed

Get report footer data (if any) for the specified report.

this method is only called once per report. This data will be assigned to smarty under the variable 'report_header_data'

Returns

process_template()

process_template() : string

Process the template, and return the results for each page of the report.

Returns