# \CGExtensions\reportsreport_generator

An abstract class for a report generator.

## Summary

Methods
Properties
Constants
__construct()
generate()
get_output()
No public properties found
No constants found
report()
start()
finish()
each_row()
No protected properties found
N/A
No private methods found
No private properties found
N/A
abstract

File
  lib/reports/class.report_generator.php
Class hierarchy
  \CGExtensions\reports\report_generator

## Tags

todo |

## Methods

### __construct()

    __construct(\CGExtensions\reports\report_defn $rpt)

Constructor.

#### Parameters

\CGExtensions\reports\report_defn | $rpt |

#

## Tags

todo |

### generate()

    generate() : void

Generate the report output.

#

## Tags

todo |

### get_output()

    get_output() : mixed

Get the generated output.

This method may return textual data suitable for echoing/displaying. Or it it may generate a static file and return nothing.

#### Returns

mixed

#

abstract

## Tags

todo |

### report()

    report() : \CGExtensions\reports\report_defn

Get the report definition.

#### Returns

\CGExtensions\reports\report_defn

#

## Tags

todo |

### start()

    start() : void

A callback function when the report is started.

#

## Tags

todo |

### finish()

    finish() : void

A callback function for when the report is finished.

#

## Tags

todo |

### each_row()

    each_row(array $row)

A callback functon for each data row.

#### Parameters

array | $row | The row returned from the query.

#

abstract

## Tags

todo |

### class.report_generator.php