Docs For Class ActionBilling

Description

Send billing data by email

Find out what sort of report is required and generate it

Located in /inc/actions/billing.php (line 38)

ActionAction
   |
   --BufferedAction
      |
      --ActionExport
         |
         --ActionBilling

Variable Summary

boolean $DEBUG_PDF

boolean $emailIndividuals

string $mail_error

Method Summary

void ActionBilling (BumblebeeAuth $auth, array $pdata)

void mungeInputData ()

void returnExport ()

void _getEmailText (string $group, string $start, string $stop)

void _getReportFilename ( $who)

void _goButton ()

void _sendPDFbyEmail (string $toName, string $toEmail, string $group, string $data)

Variables

boolean $DEBUG_PDF = false (line 53)

enable additional debugging information for PDF generation

boolean $emailIndividuals = false (line 43)

should all group leaders be send the email or just the logged in user

string $mail_error = NULL (line 48)

mail error message (if sending mail went wrong)

Inherited Variables

Inherited from ActionExport

ActionExport::$fatal_sql
ActionExport::$format
ActionExport::$typelist
ActionExport::$_daterange
ActionExport::$_export
ActionExport::$_verb

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 ActionBilling (line 62)

Initialising the class

return: nothing

void ActionBilling (BumblebeeAuth $auth, array $pdata)

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

mungeInputData (line 74)

void mungeInputData ()

Redefinition of:

ActionExport::mungeInputData()

returnExport (line 98)

get all the data and send it back to the user

void returnExport ()

Redefinition of:

ActionExport::returnExport(): Generate the data export and then send it to the user in the appropriate format

_getEmailText (line 334)

Reads the boilerplate text for the email and customise it for this email

void _getEmailText (string $group, string $start, string $stop)

string $group: name of the group for which this report is being generated
string $start: the start date for the report
string $stop: the stop date for the report

_getReportFilename (line 216)

obtain an appropriate filename for the data export

void _getReportFilename ( $who)

$who

_goButton (line 83)

convenience function to generate a submit button

void _goButton ()

Redefinition of:

ActionExport::_goButton(): Common submit button for this class

_sendPDFbyEmail (line 235)

send the PDF to the appropriate person by email the logged in user is always included in the To list for their records

void _sendPDFbyEmail (string $toName, string $toEmail, string $group, string $data)

string $toName: name of the person to receive the email
string $toEmail: email addr of recipient
string $group: name of the group for which this report is being generated
string $data: PDF data to be sent

Inherited Methods

Inherited From ActionExport

ActionExport::ActionExport()
ActionExport::formatSelect()
ActionExport::go()
ActionExport::mungeInputData()
ActionExport::outputSelect()
ActionExport::returnExport()
ActionExport::selectExport()
ActionExport::_getDataList()
ActionExport::_getDBListFromExport()
ActionExport::_getFilename()
ActionExport::_goButton()
ActionExport::_limitationSet()
ActionExport::_preparePDFExport()
ActionExport::_reportHeader()

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