Docs For Class ActionExport

Description

Export various views of the booking data in numerous formats

A number of different data views can be created (see exporttypes.php) and the data can be exported in various formats (see htmlexport.php and arrayexport.php)

This class is inherited by other exporters

Located in /inc/actions/export.php (line 56)

ActionAction
   |
   --BufferedAction
      |
      --ActionExport

Direct descendents

Class	Description
ActionBilling	Send billing data by email

Variable Summary

boolean $fatal_sql

string $format

ExportTypeList $typelist

DateRange $_daterange

ExportType $_export

string $_verb

Method Summary

void ActionExport (BumblebeeAuth $auth, array $pdata)

void formatSelect ()

void go ()

void mungeInputData ()

void outputSelect ()

void returnExport ()

void selectExport ()

DBList _getDataList ( $report)

void _getDBListFromExport ( &$export, $start, $stop, [ $limitsOffset = 0])

void _getFilename ()

void _goButton ()

array _limitationSet ( $fields, $limitsOffset, [ $makeSQL = true])

string _preparePDFExport ( &$exportArray)

string _reportHeader ()

Variables

boolean $fatal_sql = 1 (line 61)

forces SQL errors to be fatal

string $format (line 66)

name of the export format to be used

ExportTypeList $typelist (line 71)

object containing export SQL and formatting instructions

DateRange $_daterange (line 81)

The data range to be used for data export

ExportType $_export (line 76)

the specific ExportType to be used in this data export

string $_verb = 'export' (line 87)

The original action word (verb!) that instantiated this class (not its descendants) Allows HTML links back to this class to be easily made.

Inherited Variables

Inherited from BufferedAction

BufferedAction::$bufferedStream
BufferedAction::$errorMessage
BufferedAction::$filename
BufferedAction::$inline
BufferedAction::$mimetype

Inherited from ActionAction

ActionAction::$auth
ActionAction::$DEBUG
ActionAction::$ob_flush_ok
ActionAction::$PD
ActionAction::$PDATA
ActionAction::$readOnly
ActionAction::$stdmessages

Methods

Constructor ActionExport (line 96)

Initialising the class

return: nothing

void ActionExport (BumblebeeAuth $auth, array $pdata)

BumblebeeAuth $auth: Authorisation object
array $pdata: extra state data from the call path

formatSelect (line 176)

Generate HTML list for user to select which data format should be used

return: nothing

void formatSelect ()

go (line 100)

void go ()

Redefinition of:

ActionAction::go(): Actually perform the action that this Action* class is to perform

mungeInputData (line 147)

void mungeInputData ()

Redefinition of:

ActionAction::mungeInputData(): Parse the input data sources

Redefined in descendants as:

ActionBilling::mungeInputData()

outputSelect (line 204)

Generate HTML form widget for user to control output.

User can select which sub-view of the data to use and which specific parts of the data should be included (i.e. restrict by group)

return: nothing

void outputSelect ()

returnExport (line 252)

Generate the data export and then send it to the user in the appropriate format

return: nothing

void returnExport ()

Redefined in descendants as:

ActionBilling::returnExport() : get all the data and send it back to the user

selectExport (line 159)

Generate HTML list for user to select which data export should be used

return: nothing

void selectExport ()

_getDataList (line 306)

Sets up the DBlist object so that it can query the db

return: query ready to run

DBList _getDataList ( $report)

$report

_getDBListFromExport (line 332)

From the export definition in the ExportType generate a DBList query

return: DBList ready for query

void _getDBListFromExport ( &$export, $start, $stop, $limitsOffset)

&$export
$start
$stop
$limitsOffset

_getFilename (line 405)

Set the filename and mimetype for the data export

return: nothing

void _getFilename ()

_goButton (line 243)

Common submit button for this class

return: nothing

void _goButton ()

Redefined in descendants as:

ActionBilling::_goButton() : convenience function to generate a submit button

_limitationSet (line 372)

Determine what limitation should be applied to the broad query

return: SQL field IN (list...) syntax
todo: //TODO: there are limitations in the IN() syntax.... replace this with lots of booleans?

array _limitationSet ( $fields, $limitsOffset, [ $makeSQL = true])

$fields
$limitsOffset
$makeSQL

_preparePDFExport (line 434)

Generate the PDF for return to the user

return: containing the PDF
uses: PDFExport - but only loaded here so that optional library can be absent without compile errors

string _preparePDFExport ( &$exportArray)

&$exportArray

_reportHeader (line 445)

Generate the standard report header from the date range and the description in ExportType

return: the title to be used for this report

string _reportHeader ()

Inherited Methods

Inherited From BufferedAction

BufferedAction::BufferedAction()
BufferedAction::getFilename()
BufferedAction::outputTextFile()
BufferedAction::saveTextFile()
BufferedAction::sendBufferedStream()
BufferedAction::startOutputTextFile()
BufferedAction::unbuffer()
BufferedAction::unbufferForError()

Inherited From ActionAction

ActionAction::ActionAction()
ActionAction::delete()
ActionAction::edit()
ActionAction::go()
ActionAction::log()
ActionAction::mungeInputData()
ActionAction::readOnlyError()
ActionAction::reportAction()
ActionAction::select()
ActionAction::_dataCleanse()