Docs For Class ActionEmailList

Description

Generate a list of email addresses for users of particular instruments

An Action to find out what instruments the lists should be prepared for and then return the email list. Designed to be use as a per instrument "announce" list.

todo: //TODO: should this class should be split some more, with some of the details abstracted?

Located in /inc/actions/emaillist.php (line 46)

ActionAction
   |
   --ActionEmailList

Variable Summary

boolean $fatal_sql

Method Summary

void ActionEmailList (BumblebeeAuth $auth, array $pdata)

void go ()

void returnLists ()

void selectLists ()

Variables

boolean $fatal_sql = 1 (line 51)

forces SQL errors to be fatal

Inherited Variables

Inherited from ActionAction

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

Methods

Constructor ActionEmailList (line 60)

Initialising the class

return: nothing

void ActionEmailList (BumblebeeAuth $auth, array $pdata)

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

go (line 65)

void go ()

Redefinition of:

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

returnLists (line 116)

Generate the email lists

work out which instruments the user has requested for inclusion
construct an SQL query to get the email list
return the formatted data to the user

return: nothing

void returnLists ()

selectLists (line 81)

Generate an HTML form for the user to select which email lists should be used

do DB look-ups on what instruments exist
construct a table of checkboxes to allow the user to select the lists

return: nothing

void selectLists ()

Inherited Methods

Inherited From ActionAction

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