# \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_item_template()
get_item_template()
set_query()
get_resultset()
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.formatted_report_defn.php
Class hierarchy
  \CGExtensions\reports\report_defn
  \CGExtensions\reports\formatted_report_defn
See also

## Tags

todo |

## Methods

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

#

## Tags

todo |

### get_item_template()

    get_item_template() : string

Get the name of the item template.

#### Returns

string

#

## 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_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_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.formatted_report_defn.php