# \CGExtensions\reportstabular_report_defn

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.

## Summary

Methods
Properties
Constants
get_resultset()
get_groups()
set_content_columns()
get_content_columns()
define_column()
get_columns()
get_column()
add_group()
set_report_group()
get_report_group()
set_query()
get_title()
set_title()
get_description()
set_description()
No public properties found
No constants found
get_query()
No protected properties found
N/A
No private methods found
No private properties found
N/A

File
  lib/reports/class.tabular_report_defn.php
Class hierarchy
  \CGExtensions\reports\report_defn
  \CGExtensions\reports\tabular_report_defn

## Tags

todo |

## Methods

### 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

#

Inherited from
  \CGExtensions\reports\report_defn

## Tags

todo |

### get_groups()

    get_groups() : \CGExtensions\reports\tabular_report_defn_group[]

Get the groups defined for this report.

#### Returns

\CGExtensions\reports\tabular_report_defn_group[]

#

## Tags

todo |

### set_content_columns()

    set_content_columns(string[] $line)

Set the columns that will be displayed for each data row (output row that is not from a group header or footer).

The columns must be previously defined with define_column.

#### Parameters

string[] | $line | An array of column names.

#

See also

## Tags

todo |

### get_content_columns()

    get_content_columns() : string[]

Get the columns that will be displayed for each data row.

#### Returns

string[]

#

## Tags

todo |

### define_column()

    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).

#### Parameters

\CGExtensions\reports\tabular_report_defn_column | $col |

#

## Tags

todo |

### get_columns()

    get_columns() : \CGExtensions\reports\tabular_report_defn_column[]

Get the columns defined for this report.

#### Returns

\CGExtensions\reports\tabular_report_defn_column[]

#

## Tags

todo |

### get_column()

    get_column(string $key) : \CGExtensions\reports\tabular_report_defn_column|null

Get the column specified by the column name.

#### Parameters

string | $key |

#### Returns

\CGExtensions\reports\tabular_report_defn_column|null

#

## Tags

todo |

### add_group()

    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.

#### Parameters

\CGExtensions\reports\tabular_report_defn_group | $grp | The group object.

#

## Tags

todo |

### set_report_group()

    set_report_group(\CGExtensions\reports\tabular-report_defn_group $grp)

Set the report group for this report.

The report groups headers and footer lines are used for report level headers and footers.

#### Parameters

\CGExtensions\reports\tabular-report_defn_group | $grp | The group object.

#

## Tags

todo |

### get_report_group()

    get_report_group() : \CGExtensions\reports\tabular_report_defn_group|null

Get the report group for this report (if there is one).

#### Returns

\CGExtensions\reports\tabular_report_defn_group|null

#

## Tags

todo |

### set_query()

    set_query(\CGExtensions\query\query $query)

Set the query that will be used for this report.

#### Parameters

\CGExtensions\query\query | $query | The query object

#

Inherited from
  \CGExtensions\reports\report_defn

## Tags

todo |

### get_title()

    get_title() : string

Get the title of this report.

#### Returns

string

#

Inherited from
  \CGExtensions\reports\report_defn

## Tags

todo |

### set_title()

    set_title(string $str)

Set the title of this report.

#### Parameters

string | $str | The title

#

Inherited from
  \CGExtensions\reports\report_defn

## Tags

todo |

### get_description()

    get_description() : string

Get the description of this report.

#### Returns

string

#

Inherited from
  \CGExtensions\reports\report_defn

## Tags

todo |

### set_description()

    set_description(string $str)

Set the description for this report

#### Parameters

string | $str | The description

#

Inherited from
  \CGExtensions\reports\report_defn

## Tags

todo |

### get_query()

    get_query() : \CGExtensions\query\query&

Get the query object used for this report.

#### Returns

\CGExtensions\query\query& —

The query object.

#

Inherited from
  \CGExtensions\reports\report_defn

## Tags

todo |

### class.tabular_report_defn.php