\CGExtensions\reportstext_report_generator

__construct()

__construct(\CGExtensions\reports\report_defn  $rpt) 

Constructor.

Parameters

generate()

generate() : void

Generate the report output.

get_output()

get_output() : string

Get the output of the report.

Returns

Output suitable for saving to a text file.

set_column_width()

set_column_width(integer  $val) 

Set the width of each column (in characters)

Parameters

before_line()

before_line() : void

A callback function that is called before each and every line.

after_line()

after_line() : void

A callback function that is called after each and every line.

before_group_footers()

before_group_footers() : void

A callback function that is called before the start of outputing group footers.

after_group_footers()

after_group_footers() : void

A callback function that is called after the outputing group footers.

before_group_headers()

before_group_headers() : void

A callback function that is called before the outputing group headers.

after_group_headers()

after_group_headers() : void

A callback function that is called after the outputing group headers.

draw_cell()

draw_cell(\CGExtensions\reports\tabular_report_cellfmt  $cell, string  $contents) 

A callback function to draw a cell.

Parameters

get_cell_contents()

get_cell_contents(string  $col_key, string  $tpl = null, array  $row = null) : string

A function to get cell contents for the specified column of the current row.

Parameters

Returns

The formatted cell contents.

get_group_cell_contents()

get_group_cell_contents(string  $col_key, string  $grp_key, string  $tpl, array  $row = null) : string

A function to get cell contents for a group header or footer cell.

Parameters

Returns

The formatted cell contents.

before_row()

before_row() : void

A callback function called before each row.

after_row()

after_row() : void

A callback function called after each row.

changed()

changed(\CGExtensions\reports\tabular_report_defn_group  $grp, array  $row) : boolean

Test if the value for a specified group has changed.

Parameters

Returns

before_group_header()

before_group_header(\CGExtensions\reports\tabular_report_defn_group  $grp, boolean  $is_first = FALSE) : void

A callback function that is called before a single group header is output.

Parameters

after_group_header()

after_group_header(\CGExtensions\reports\tabular_report_defn_group  $grp) : void

A callback function that is called after a single group header is output.

Parameters

before_group_footer()

before_group_footer(\CGExtensions\reports\tabular_report_defn_group  $grp) : void

A callback function that is called before a single group footer is generated.

Parameters

after_group_footer()

after_group_footer(\CGExtensions\reports\tabular_report_defn_group  $grp) : void

A callback function that is called after a single group footer is generated.

Parameters

report()

report() : \CGExtensions\reports\report_defn

Get the report definition.

Returns

start()

start() : void

A callback function when the report is started.

finish()

finish() : void

A callback function for when the report is finished.

each_row()

each_row(array  $row) 

A callback functon for each data row.

Parameters

get_column_width()

get_column_width() : integer

Get the column width (in characters)

Returns