\CGExtensions\reportsformatted_report_defn

A simple class that generates a report using a template to format the layout of each item or row.

This class is used by the formatted_report_generator to generate output.

Summary

Methods

Properties

Constants

set_query()
get_resultset()
get_title()
set_title()
get_description()
set_description()
set_item_template()
get_item_template()

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.formatted_report_defn.php
Package: CGExtensions
Class hierarchy: \CGExtensions\reports\report_defn

\CGExtensions\reports\formatted_report_defn
See also: \CGExtensions\reports\formatted_report_generator

Methods

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

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

get_title()

get_title() : string

Get the title of this report.

Returns

string

set_title()

set_title(string  $str)

Set the title of this report.

Parameters

string

$str

The title

get_description()

get_description() : string

Get the description of this report.

Returns

string

set_description()

set_description(string  $str)

Set the description for this report

Parameters

string

$str

The description

set_item_template()

set_item_template(string  $tpl)

Set the item template.

Parameters

string

$tpl

The name of the item template. If the parameter ends with .tpl a file template will be assumed.

get_item_template()

get_item_template() : string

Get the name of the item template.

Returns

string

get_query()

get_query() : \CGExtensions\query\query&

Get the query object used for this report.

Returns

\CGExtensions\query\query& —

The query object.