\CGExtensions\reportstabular_report_defn_column

__construct()

__construct(string  $key, string  $label, string  $fmt = null, string  $align = null, integer  $sorting = null) 

Construct a new column definition.

A column definition defines how values in an entire column will be treated.

Parameters

get_key()

get_key() : string

Get the key (column name) for this object.

Returns

get_template()

get_template() : string

Get the template for values in this cell format

Returns

set_template()

set_template(string  $tpl) 

Set the template for values in this cell format.

Parameters

get_alignment()

get_alignment() : string

Get the alignment for cells using this format.

Returns

get_span()

get_span() : integer

Get the cell span for cells using this format.

Returns

get_class()

get_class() : string

Get the class name (if any) assigned to this cell format

Returns

set_class()

set_class(string  $class) 

Set a class name to use when outputting cells using this format.

Some generators may ignore this value. But HTML type generators will typically use this as a class name for the table cell.

Parameters

get_label()

get_label() : string

Get the label for this column definition.

Returns

set_label()

set_label(string  $label) 

Set the label or this column definition

Parameters

get_sorting()

get_sorting() : integer

Get the sorting for this column definition.

Returns

set_sorting()

set_sorting(integer  $sorting) 

Set the sorting for this column definition

Parameters

set_value_processor()

set_value_processor(callable  $fn) 

Set an optional mechanism to adjust, process, or return a different value for values in this column.

This can be used for doing mathematical formulas on values, or retrieving foreign key related data from the database or otherwise translating input data.

Parameters

process_value()

process_value(string  $val, \CGExtensions\query\resultset  $rs) 

A callback method to process a value in this column.

by default this method will call the value processor callback (if defined), otherwise it will do nothing. This method is normally called by the report generator to determine the output value (but not the displayed string) for the column.

Parameters

add_history_value()

add_history_value(string  $val) 

Save a value for this column. Useful in calcualting statistics that are global to the entire report.

This method is normally called by the report generator.

Parameters

add_group_history_value()

add_group_history_value(string  $grp_key, string  $val) 

Add a group history value. Useful in calculating statistics for a specific group.

This method is normally called by the report generator.

Parameters

changed()

changed(string  $val) : boolean

A function to test if the supplied value for this column has changed from the previous global value. This can be useful for detecting if a group has changed.

This method is normally called by the report generator.

Parameters

Returns

reset_group()

reset_group(string  $grp_key) 

Clear all cached values for a specified group

Parameters

get_count()

get_count() : integer

Get the count of values stored for this column.

Returns

get_min()

get_min() : string

Get the minimum of all values stored for this column.

This method assumes that the data stored is in someway numeric, and can be compared using numeric operators.

Returns

get_max()

get_max() : string

Get the maximum of all values stored for this column.

This method assumes that the data stored is in someway numeric, and can be compared using numeric operators.

Returns

get_sum()

get_sum() : string

Get the sum of all values stored for this column.

This method assumes that the data stored is in someway numeric, and can be compared using numeric operators.

Returns

get_mean()

get_mean() : string

Get the mean/average of all values stored for this column.

This method assumes that the data stored is in someway numeric, and can be compared using numeric operators.

Returns

get_median()

get_median() : string

Get the median/middle of all values stored for this column.

This method assumes that the data stored is in someway numeric, and can be compared using numeric operators.

Returns

get_grp_count()

get_grp_count(string  $grp_key) : integer

Get the count of all values stored for this column for the specified group.

Parameters

Returns

get_grp_min()

get_grp_min(string  $grp_key) : string

Get the minimum of all values stored for this column for the specified group This method assumes that the data stored is in someway numeric, and can be compared using numeric operators.

Parameters

Returns

get_grp_max()

get_grp_max(string  $grp_key) : string

Get the maximum of all values stored for this column for the specified group This method assumes that the data stored is in someway numeric, and can be compared using numeric operators.

Parameters

Returns

get_grp_sum()

get_grp_sum(string  $grp_key) : string

Get the sum of all values stored for this column for the specified group This method assumes that the data stored is in someway numeric, and can be compared using numeric operators.

Parameters

Returns

get_grp_mean()

get_grp_mean(string  $grp_key) : string

Get the mean/average of all values stored for this column for the specified group This method assumes that the data stored is in someway numeric, and can be compared using numeric operators.

Parameters

Returns

get_grp_median()

get_grp_median(string  $grp_key) : string

Get the median/middle of all values stored for this column for the specified group This method assumes that the data stored is in someway numeric, and can be compared using numeric operators.

Parameters

Returns

get_grp_values()

get_grp_values(string  $grp_key) : array<mixed,string>

Get all of the values stored for this column for the named group.

Parameters

Returns