Form_Email_Edit_Fns Class Reference

Inheritance diagram for Form_Email_Edit_Fns:

Public Member Functions
	Form_Email_Edit_Fns ()
	paintSubmissionDateRange (&$asset, &$o, $prefix)
	paintSubmissionCount (&$asset, &$o, $prefix)
	paintSubmissionList (&$asset, &$o, $prefix)
	processSubmissionList (&$asset, &$o, $prefix)
	paintDownloadDateRange (&$asset, &$o, $prefix)
	paintDownloadFormat (&$asset, &$o, $prefix)
	paintDownloadButton (&$asset, &$o, $prefix)
	processDownloadButton (&$asset, &$o, $prefix)
	processExportCSV (&$asset, &$o, $prefix, $header_row=TRUE, $delimiter=',')
	createCSVSubmissionLogs ($form, $from_time, $to_time)
	processExportXML (&$asset, &$o, $prefix)
	paintSendSubmissionsEmail (Form_Email $asset, Backend_Outputter $o, $prefix)
	processSendSubmissionsEmail (Form_Email $asset, Backend_Outputter $o, $prefix)
	_getSubmissionLog ($bind_vars)
&	_generateSubmissionList (&$tree_root)
	paintReceiptField (&$asset, &$o, $prefix)
	processReceiptField (&$asset, &$o, $prefix)
	paintSTAFField (&$asset, &$o, $prefix)
	processSTAFField (&$asset, &$o, $prefix)
	paintAddSelectiveEmailRule (&$asset, &$o, $prefix)
	processAddSelectiveEmailRule (&$asset, &$o, $prefix)
	paintCurrentSelectiveEmails (&$asset, &$o, $prefix)
	processCurrentSelectiveEmails (&$asset, &$o, $prefix)
	paintActiveQuestion (&$asset, &$o, $prefix)
	processActiveQuestion (&$asset, &$o, $prefix)
	paintAddRulePart (&$asset, &$o, $prefix)
	processAddRulePart (&$asset, &$o, $prefix)
	paintRuleParts (&$asset, &$o, $prefix)
	processRuleParts (&$asset, &$o, $prefix)
	paintActiveSend (&$asset, &$o, $prefix)
	processActiveSend (&$asset, &$o, $prefix)
	paintKeywordReplacementText (&$asset, &$o, $prefix)
	processKeywordReplacementText (&$asset, &$o, $prefix)
	hasAttributeWriteAccess (&$asset, &$o)
	paintAllActions (Form_Email $asset, Backend_Outputter $o, $prefix)
	processAllActions (Form_Email $asset, Backend_Outputter $o, $prefix)
	paintNewAction (Form_Email $asset, Backend_Outputter $o, $prefix)
	processNewAction (Form_Email $asset, Backend_Outputter $o, $prefix)
	paintSelectedAction (Form_Email $asset, Backend_Outputter $o, $prefix)
	processSelectedAction (Form_Email $asset, Backend_Outputter $o, $prefix)
Public Member Functions inherited from Form_Edit_Fns
	Form_Edit_Fns ()
	paintSectionLinks (&$asset, &$o, $prefix)
	processSectionLinks (&$asset, &$o, $prefix)
	paintQuestionLinks (&$asset, &$o, $prefix)
	processQuestionLinks (&$asset, &$o, $prefix)
	paintUseBodycopy (&$asset, &$o, $prefix)
	processUseBodycopy (&$asset, &$o, $prefix)
	paintAddQuestions (&$asset, &$o, $prefix)
	processAddQuestions (&$asset, &$o, $prefix)
	paintAddSections (&$asset, &$o, $prefix)
	processAddSections (&$asset, &$o, $prefix)
	paintSubmissions (&$asset)
	processSubmissions (&$asset)
	paintSimpleFormatting (&$asset, &$o, $prefix)
	processSimpleFormatting (&$asset, &$o, $prefix)
	paintComplexFormatting (&$asset, &$o, $prefix)
	processComplexFormatting (&$asset, &$o, $prefix)
	paintCaptchaFontField (&$asset, &$o, $prefix)
	processCaptchaFontField (&$asset, &$o, $prefix)
	generateStandardContentFile (&$asset)
	generateQuestionsContentFile (&$asset)
	generateGenericSection (&$asset)
	paintMollomQuestionToCheck (&$asset, &$o, $prefix)
	processMollomQuestionToCheck (&$asset, &$o, $prefix)
	paintSubmissionLimit (&$asset, &$o, $prefix)
	processSubmissionLimit (&$asset, &$o, $prefix)
Public Member Functions inherited from Asset_Edit_Fns
	Asset_Edit_Fns ()
	paintPaths (&$asset, &$o, $prefix)
	paintEditRemapURLs (&$asset, &$o, $prefix)
	processPaths (&$asset, &$o, $prefix)
	processEditRemapURLs (&$asset, &$o, $prefix)
	paintURLs (&$asset, &$o, $prefix)
	paintAddRemapURLs (&$asset, &$o, $prefix)
	processAddRemapURLs (&$asset, &$o, $prefix)
	isWorkflowComplete (&$asset)
	paintNoticeLinkedAsset (&$asset, $link_value, $type_codes=Array(), $field_name='', $multiple=FALSE)
	processNoticeLinkedAsset (&$asset, $link_value, $field_name='', $multiple=FALSE)
	isSearchInstalled (&$asset, $prefix)
	isBeingCreated (&$asset)
	isNotBeingCreated (&$asset)
	paintAutomaticRemapSetting (&$asset, &$o, $prefix)
	paintCreateLink (&$asset, &$o, $prefix)
Public Member Functions inherited from MySource_Object
	MySource_Object ()
	__sleep ()
	__wakeup ()

Protected Member Functions
	_makeValidActionName (Form_Email $asset, $base_name)
Protected Member Functions inherited from Form_Edit_Fns
	_getBodycopiesList ()

Additional Inherited Members
Data Fields inherited from Asset_Edit_Fns
	$static_screens

Detailed Description

Definition at line 34 of file form_email_edit_fns.inc.

Member Function Documentation

& _generateSubmissionList

(

&

$tree_root

)

Returns a list of name-value pairs for a submission result

Parameters

object

&$tree_root

the XML node that we are going to process

Returns

array private

Definition at line 1113 of file form_email_edit_fns.inc.

_getSubmissionLog

(

$bind_vars

)

Get the submission log from the database

Parameters

array

$bind_vars

the bind vars to process

Returns

array private

Definition at line 1057 of file form_email_edit_fns.inc.

_makeValidActionName ( Form_Email  $asset,   $base_name  )

protected

Make an action name valid by adding a numeric index to it if a duplicate

Returns the base name if no duplicate name is found, or tries "Base Name 2", "Base Name 3", and so on, until a unique name is found, and returns the first unique name it finds.

Parameters

Form_Email	$asset	The form whose interface we are painting
string	$base_name	Base name to use

Returns

boolean

Definition at line 2342 of file form_email_edit_fns.inc.

createCSVSubmissionLogs	(		$form,
			$from_time,
			$to_time
	)

Create a CSV submission log of all the Form submissions in a period of time.

Parameters

Form	$form	The Form that submissions were submitted to
int	$from_time	The Unix timestamp of the from time
int	$to_time	The Unix timestamp of the to time

Definition at line 768 of file form_email_edit_fns.inc.

Form_Email_Edit_Fns

(

)

Constructor

Definition at line 42 of file form_email_edit_fns.inc.

hasAttributeWriteAccess	(	&	$asset,
		&	$o
	)

Returns TRUE if the attribute lock is acquired

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class

Returns

boolean public

Definition at line 1941 of file form_email_edit_fns.inc.

paintActiveQuestion	(	&	$asset,
		&	$o,
			$prefix
	)

Processes the interface for selecting a question for a rule part

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 1548 of file form_email_edit_fns.inc.

paintActiveSend	(	&	$asset,
		&	$o,
			$prefix
	)

Paint the dropdowns etc for the rule logic

When <all|any> rule parts are matched, send an <email type>=""> email to <email address>="">

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 1827 of file form_email_edit_fns.inc.

paintAddRulePart	(	&	$asset,
		&	$o,
			$prefix
	)

Paint the dropdowns to add rule parts to a Selective Email rule

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 1590 of file form_email_edit_fns.inc.

paintAddSelectiveEmailRule	(	&	$asset,
		&	$o,
			$prefix
	)

Paints the interface for creating a new Selective Email rule

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 1300 of file form_email_edit_fns.inc.

paintAllActions	(	Form_Email	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Paints the interface for printing all existing actions

Parameters

Form_Email	$asset	The form whose interface we are painting
Backend_Outputter	$o	the outputter class
string	$prefix	prefix for form elements

Returns

boolean

Definition at line 1959 of file form_email_edit_fns.inc.

paintCurrentSelectiveEmails	(	&	$asset,
		&	$o,
			$prefix
	)

paint the current rules

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 1370 of file form_email_edit_fns.inc.

paintDownloadButton	(	&	$asset,
		&	$o,
			$prefix
	)

Paints the download button for the export block

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 660 of file form_email_edit_fns.inc.

paintDownloadDateRange	(	&	$asset,
		&	$o,
			$prefix
	)

Paints the download date range selector for the export block

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 591 of file form_email_edit_fns.inc.

paintDownloadFormat	(	&	$asset,
		&	$o,
			$prefix
	)

Paints the download format selector for the export block

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 631 of file form_email_edit_fns.inc.

paintKeywordReplacementText	(	&	$asset,
		&	$o,
			$prefix
	)

Paint a note giving instructions for complex formatting

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 1902 of file form_email_edit_fns.inc.

paintNewAction	(	Form_Email	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Paints the interface for creating a new action

Parameters

Form_Email	$asset	The form whose interface we are painting
Backend_Outputter	$o	the outputter class
string	$prefix	prefix for form elements

Returns

boolean

Definition at line 2106 of file form_email_edit_fns.inc.

paintReceiptField	(	&	$asset,
		&	$o,
			$prefix
	)

Paints the interface for selecting a field containing send to a friend entries

Parameters

object	&$asset	the form involved
object	&$o	the backend outputter
string	$prefix	a unique prefix for variables

Returns

boolean public

Definition at line 1172 of file form_email_edit_fns.inc.

paintRuleParts	(	&	$asset,
		&	$o,
			$prefix
	)

Paints the interface for editing and deleting Rule Parts

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 1687 of file form_email_edit_fns.inc.

paintSelectedAction	(	Form_Email	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Paints the interface for the selected submission action

Parameters

Form_Email	$asset	The form whose interface we are painting
Backend_Outputter	$o	the outputter class
string	$prefix	prefix for form elements

Returns

boolean

Definition at line 2211 of file form_email_edit_fns.inc.

paintSendSubmissionsEmail	(	Form_Email	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Paints the interface for the existing "Send Submissions Email" jobs

Parameters

Form_Email	$asset	The form whose interface we are painting
Backend_Outputter	$o	the outputter class
string	$prefix	prefix for form elements

Returns

boolean

Definition at line 913 of file form_email_edit_fns.inc.

paintSTAFField	(	&	$asset,
		&	$o,
			$prefix
	)

Paints the interface for selecting a field containing send to a friend entries

Parameters

object	&$asset	the form involved
object	&$o	the backend outputter
string	$prefix	a unique prefix for variables

Returns

boolean public

Definition at line 1235 of file form_email_edit_fns.inc.

paintSubmissionCount	(	&	$asset,
		&	$o,
			$prefix
	)

Paints the submission count interface

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 104 of file form_email_edit_fns.inc.

paintSubmissionDateRange	(	&	$asset,
		&	$o,
			$prefix
	)

Paints the date range selector

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 62 of file form_email_edit_fns.inc.

paintSubmissionList	(	&	$asset,
		&	$o,
			$prefix
	)

Paints the submission list

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 124 of file form_email_edit_fns.inc.

processActiveQuestion	(	&	$asset,
		&	$o,
			$prefix
	)

Processes the interface for selecting active question (no implementation required)

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 1573 of file form_email_edit_fns.inc.

processActiveSend	(	&	$asset,
		&	$o,
			$prefix
	)

Process the newly added questions

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 1872 of file form_email_edit_fns.inc.

processAddRulePart	(	&	$asset,
		&	$o,
			$prefix
	)

Process the interface for adding a rule part to a Selective Email rule

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 1636 of file form_email_edit_fns.inc.

processAddSelectiveEmailRule	(	&	$asset,
		&	$o,
			$prefix
	)

Processes the interface for creating a new, blank Selective Email rule

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 1321 of file form_email_edit_fns.inc.

processAllActions	(	Form_Email	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Performs processing for the actions table

Parameters

Form_Email	$asset	The form whose interface we are processing
Backend_Outputter	$o	the outputter class
string	$prefix	prefix for form elements

Returns

boolean

Definition at line 2048 of file form_email_edit_fns.inc.

processCurrentSelectiveEmails	(	&	$asset,
		&	$o,
			$prefix
	)

Processes the interface for deleting current selective email rules

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 1514 of file form_email_edit_fns.inc.

processDownloadButton	(	&	$asset,
		&	$o,
			$prefix
	)

Processes the Download Button press

This function will pass off the work to processExportCSV() or processExportXML(), as appropriate. If we aren't downloading a file, this function will silently return a success.

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 689 of file form_email_edit_fns.inc.

processExportCSV	(	&	$asset,
		&	$o,
			$prefix,
			$header_row = TRUE,
			$delimiter = ','
	)

Exports chosen submissions to a comma separated value (CSV) file

Will only perform export for the date range which was selected in the Export block.

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements
boolean	$header_row	whether the header row is filled in
string	$delimiter	delimiter char

Returns

boolean public

Definition at line 731 of file form_email_edit_fns.inc.

processExportXML	(	&	$asset,
		&	$o,
			$prefix
	)

Exports chosen submissions to an XML format

XML format is the same format used to store the submission logs, with an overarching "submissions" root tag around it. Will only perform export for the date range which was selected in the Export block.

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 849 of file form_email_edit_fns.inc.

processKeywordReplacementText	(	&	$asset,
		&	$o,
			$prefix
	)

Process the note giving instructions for keyword replacements

Nothing to process, so return false always.

Parameters

object	&$asset	the asset to which we belong
object	&$o	the outputter class
string	$prefix	prefix for the form element

Returns

boolean public

Definition at line 1925 of file form_email_edit_fns.inc.

processNewAction	(	Form_Email	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Processes the creation of a new action

Parameters

Form_Email	$asset	The form whose interface we are processing
Backend_Outputter	$o	the outputter class
string	$prefix	prefix for form elements

Returns

boolean

Definition at line 2144 of file form_email_edit_fns.inc.

processReceiptField	(	&	$asset,
		&	$o,
			$prefix
	)

Processes the interface for selecting a field containing a receipt email

Parameters

object	&$asset	the form involved
object	&$o	the backend outputter
string	$prefix	a unique prefix for variables

Returns

boolean public

Definition at line 1202 of file form_email_edit_fns.inc.

processRuleParts	(	&	$asset,
		&	$o,
			$prefix
	)

Processes the interface for editing and deleting Rule Parts

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 1772 of file form_email_edit_fns.inc.

processSelectedAction	(	Form_Email	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Processes the interface for the selected action

Parameters

Form_Email	$asset	The form whose interface we are painting
Backend_Outputter	$o	the outputter class
string	$prefix	prefix for form elements

Returns

boolean

Definition at line 2276 of file form_email_edit_fns.inc.

processSendSubmissionsEmail	(	Form_Email	$asset,
		Backend_Outputter	$o,
			$prefix
	)

Processes the interface for the existing "Send Submissions Email" jobs

Parameters

Form_Email	$asset	The form whose interface we are painting
Backend_Outputter	$o	the outputter class
string	$prefix	prefix for form elements

Returns

boolean

Definition at line 986 of file form_email_edit_fns.inc.

processSTAFField	(	&	$asset,
		&	$o,
			$prefix
	)

Processes the interface for selecting a field containing send to a friend entries

Parameters

object	&$asset	the form involved
object	&$o	the backend outputter
string	$prefix	a unique prefix for variables

Returns

boolean public

Definition at line 1265 of file form_email_edit_fns.inc.

processSubmissionList	(	&	$asset,
		&	$o,
			$prefix
	)

Processes the submissions block (only processes deletion of submissions)

Parameters

object	&$asset	the asset whose interface we are painting
object	&$o	the outputter class
string	$prefix	prefix for the form elements

Returns

boolean public

Definition at line 515 of file form_email_edit_fns.inc.

---

The documentation for this class was generated from the following file:

• /Users/webmaster/Desktop/squiz_matrix/packages/cms/form/form_email/form_email_edit_fns.inc