Form_Email Class Reference

Inheritance diagram for Form_Email:

Public Member Functions
	Form_Email ($assetid=0)
	_getName ($short_name=FALSE, $contextid=NULL)
	getFormHeader ()
	getFormInfo ($html=FALSE)
	cloneComponents (&$clone, $components, $override=FALSE)
	deleteQuestion (&$question)
	finishForm ()
	mailReceipt ()
	mailRecipients ()
	_getAttachments ()
	sendToFriends ()
	runSelectiveEmails ()
	sendEmail (&$email_format_attr, $replacements=Array())
	performSubmissionActions ($before_submit=FALSE)
	_getThankYouKeywordReplacement ($keyword)
Public Member Functions inherited from Form
	Form ($assetid=0)
	create (&$link)
	_createAdditional (&$link)
	_getAllowedLinks ()
	linksUpdated ()
	cloneComponents (&$clone, $components, $override=FALSE)
	cloneComponentsAdditional (&$clone, $components)
	_cloneDIVContents ($content_type, $original_clones=Array(), $replace_keywords=Array())
	getAsset ($assetid, $type_code='', $mute_errors=FALSE)
	getLinks ($assetid, $link_types, $type_code='', $strict_type_code=TRUE, $side_of_link='major', $sort_by=NULL)
	getAssetMapLinks ()
	getParents ($shadowid, $type_code='', $strict_type_code=TRUE)
	getChildren ($assetid, $type_code='', $strict_type_code=TRUE, $dependant=NULL, $sort_by=NULL)
	_updated ($update_parents=TRUE)
	canCreateLink (&$minor, $link_type, $exclusive)
	prepareLink (&$asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
	countLinks ($assetid, $side_of_link='major', $link_types=0, $type_code='', $strict_type_code=TRUE, $ignore_linkid=0)
	getLineageFromURL ($assetid, $protocol, $url)
	getPermission ($assetid, $permission, $granted=NULL, $and_greater=TRUE, $expand_groups=FALSE, $all_info=FALSE)
	setPermission ($assetid, $userid, $permission, $granted)
	deletePermission ($assetid, $userid, $permission)
	getAssetInfo ($assetids, $type_code=Array(), $strict_type_code=TRUE, $field='')
	assetExists ($assetids)
	getLink ($assetid, $link_type=NULL, $type_code='', $strict_type_code=TRUE, $value=NULL, $side_of_link='major', $exclusive=NULL)
	getLinkById ($linkid, $assetid=0, $side_of_link='major')
	getLinkByAsset ($assetid, $other_assetid, $link_types=NULL, $value=NULL, $side_of_link='major', $force_array=FALSE, $dependant=NULL, $exclusive=NULL)
	getAllChildLinks ($assetid, $link_type=0)
	updateLink ($linkid, $link_type=NULL, $value=NULL, $sort_order=NULL)
	deleteAssetLink ($linkid, $moving=FALSE)
	getAssetMapAssetInfo ($assetid)
	createAssetLink (&$major, &$minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0', $moving=FALSE)
&	getQuestions ()
&	getAllQuestions ()
&	getQuestionAssets ($type_code=NULL)
&	getAllQuestionAssets ($type_code=NULL)
	getQuestionAssetsOnPage ($page_number)
	attachQuestion ($type_code)
	deleteQuestion (&$question)
	getQuestionCount ()
	getQuestionByID ($questionid)
&	getQuestionByOrder ($orderid)
&	getSections ()
&	getAllSections ()
	getSectionCount ()
&	getSectionLinks ()
	printBody ()
	getFormHeader ()
	getFormAction ()
	getPageContents ($page_number)
	getFormFooter ()
	printPageContentsBodycopy ()
	printThankYouBodycopy ()
	printForm ($replacements=Array())
	printDefaultPageContents ($also_print_sections=TRUE)
	getResumeSubmissionPageContents ()
	printStandard ()
	getExitPage ()
	createBodycopy ($name, $content=Array())
&	getBodycopy ($name='', $link_type=SQ_LINK_TYPE_2)
	includeContentFile ($type='Standard')
	getTotalPages ()
	getConfirmationPageContents ()
	getDefaultConfirmationPageContents ()
	fileRegeneration ()
	processPage ($page_number, $validate_page=TRUE, $mute_errors=FALSE)
	repopulate ()
	printErrors ()
	getXML ($time=NULL)
	printSummary ($html=FALSE)
	printSemanticSummary ()
	getFormInfo ()
	generateJSCode ()
	getClientSideFunction ()
	completeSubmission ()
	finishForm ()
	getSubmissionsFolder ($link_value='submissions_folder')
	createSubmissionsFolder ($folder_name, $link_value)
&	createSubmission ($create_in_completed=FALSE)
&	getSubmissionAsset ()
	updateSubmission (Form_Submission $submission_asset)
	getIncompleteSubmissions ()
	getCurrentPageNumber ()
	getLatestPageNumber ()
	getTempFileUploadPath ()
	restoreFromSubmissionCookie ()
	updateSubmissionCookie ()
	convertSubmissionCookieToAsset ()
	onRequestKeywords (&$broadcaster, $vars=Array())
	_getPageContentsBodycopyKeywords ()
	_getSubmissionLimitReachedBodycopyKeywords ()
	_getThankYouBodycopyKeywords ()
	getDisplayKeywordReplacement ($keyword)
	getCurrentPageContentsKeywordReplacement ()
	getCurrentPageNameKeywordReplacement ($current_page=NULL)
	getPageNumberKeywordReplacement ()
	getTotalPagesKeywordReplacement ()
	getFormContentsKeywordReplacement ()
	getFormContentsNoSectionsKeywordReplacement ()
	getFormCaptchaKeywordReplacement ()
	getFormCaptchaImageKeywordReplacement ()
	getFormCaptchaFieldKeywordReplacement ()
	getFormCaptchaLinkKeywordReplacement ()
	getFormErrorsKeywordReplacement ()
	getFormErrorsMessageKeywordReplacement ()
	getSubmitButtonKeywordReplacement ()
	getSaveButtonKeywordReplacement ()
	getSaveConfirmationKeywordReplacement ()
	getSaveAndExitButtonKeywordReplacement ()
	getResetButtonKeywordReplacement ()
	getPreviousPageButtonKeywordReplacement ()
	getPageListKeywordReplacement ()
	_getThankYouKeywordReplacement ($keyword)
	performFormSectionActions ($page_number)
	_finaliseStepsActions ()
	getSubmissionCount ()
	printSubmissionLimitReachedBodycopy ($replacements=Array())
Public Member Functions inherited from Asset
	Asset ($assetid=0)
	create (Array &$link)
	load ($assetid)
	_loadDataPaths ()
	reload ()
	canDelete ()
	delete ($release_lock=TRUE, $check_locked=TRUE)
	useSystemVersion ()
	loadSystemVersion ()
	saveSystemVersion ()
	clearSystemVersion ()
	revertToSystemVersion ()
	revertNoticeLinksToSystemVersion ()
	_updated ($update_parents=TRUE)
	type ()
	getTypeAncestors ($include_asset=TRUE)
	incrementVersion ($number='micro', $update_parents=TRUE)
	getLanguages ()
	setLanguages (Array $languages)
	setCharset ($charset)
	setForceSecure ($force_secure)
	remapAssetids (Array $map)
	morph ($new_type_code)
	_morphCleanup ($new_type_code)
	onRequestKeywords (Asset $broadcaster, Array $vars=Array())
	canClone ()
	cloneComponents (Asset $clone, Array $components, $override=FALSE)
	cloneComponentsAdditional (Asset $clone, Array $components)
	cloneLinks (Asset $clone)
	getStatus ()
	getAvailableStatii ()
	getStatusDescription ()
	processStatusChange ($new_status, $update_parents=TRUE, $run_updated=TRUE)
	setDate ($date_type, $time=NULL, $userid=NULL)
	lockTypes ()
	canForceablyAcquireLock ($lock_type)
	getEditingLocks ($keywords)
	_getAllowedLinks ()
	createLink (Asset $minor, $link_type, $value='', $sort_order=NULL, $dependant='0', $exclusive='0', $moving=FALSE, $locked=0)
	prepareLink (Asset $asset, $side_of_link, &$link_type, &$value, &$sort_order, &$dependant, &$exclusive)
	canCreateLink (Asset $minor, $link_type, $exclusive)
	canMoveLink (Asset $minor, Asset $old_major, $link_type)
	describeLink ($linkid)
	isDeletableLink ($linkid)
	canDeleteLink ($linkid)
	deleteLink ($linkid, $check_locked=TRUE)
	linksUpdated ()
	canCloneLink ()
	saveAttributes ($dont_run_updated=FALSE, $log_message=TRUE)
	setAttrValue ($name, $value)
	attr ($name)
&	attrByRef ($name)
	getAttribute ($name, $mute_errors=FALSE)
	getAssetKeywords ($descriptions=FALSE)
	getAvailableKeywords ()
	getKeywordReplacement ($keyword)
	getAssetWebPathKeywordReplacement ()
	getCustomKeywordReplacements ($keywords=Array(), $invoke_backend=FALSE)
	processCustomKeywords ($keywords=Array())
	getContent ()
	setContent ()
	getEffectiveLastUpdatedTime ($assetids)
	readAccess (Array $assetids=Array())
	writeAccess ($lock_type='', Array $assetids=Array(), $only_workflow=TRUE)
	adminAccess ($lock_type='', Array $assetids=Array())
	backendAccess ()
	liveEditAccess ($lock_type)
	canliveEdit ($lock_type)
	effectiveUnrestricted ()
	checkAccess ($perm, $lock_type, Array $assetids=Array(), $only_workflow=TRUE)
	accessEffective ()
	permissionsUpdated ()
	printFrontend ()
	printFrontendAsset (Asset $asset, $design=NULL)
	getValidProtocols ()
	printHead ()
	printBody ()
	getCurrentPaintLayoutName ()
	getCurrentDesignName ()
	printBodyWithPaintLayout ($layout_id='')
	initLimbo ()
	printLimbo ()
	paintBackend (Backend_Outputter $o)
	getPrefix ()
	processBackend (Backend_Outputter $o, Array &$link)
	getEI ()
	getEditFns ()
	getBackendHref ($screen='', $backend_page=TRUE)
	getURL ($base_url=NULL, $ignore_rollback=FALSE, $base_contextid=NULL)
	getURLs ()
	getHref ($base_url=NULL, $ignore_rollback=FALSE)
	getWebDataPath ()
	getWebPaths ()
	saveWebPaths ($paths, $auto_add_remaps=TRUE)
	getLookups ($field='')
	getDesignLookups ()
	getLookupValues ($inherited=NULL, $prefix='', $like_search=TRUE, $ignore_override=FALSE)
	deleteLookupValue ($layout_name, $layout_value)
	setPaintLayouts ($layouts)
	updateLookups ($auto_add_remaps=TRUE)
	setLookupValues (Array $values)
	getAssetStatusDescriptionKeywordReplacement ()
	getAssetStatusColourKeywordReplacement ()
	replaceKeywordsInString ($string)
	fastTrack ($tasks)
	unFastTrack ($tasks)
	shouldFastTrack ($task, $assetid=NULL)
	getFaskTrackedTaskAssetids ($task)
	getDependantParentsURL ()
Public Member Functions inherited from MySource_Object
	MySource_Object ()
	__sleep ()
	__wakeup ()

Additional Inherited Members
Data Fields inherited from Form
	$current_answers = Array()
	$extra_data = Array()
	$active_section = NULL
	$submission_errors = NULL
	$submission_asset = NULL
Protected Member Functions inherited from Form
	_getName ($short_name=FALSE, $contextid=NULL)
	_handleCompletedFileUploads ()
	_getConfirmationPageContentsBodycopyKeywords ()
	_getCommonQuestionKeywords (Form_Question $question, Asset $parent)
	_getCommonSectionKeywords (Form_Section $section)
	_getQuestionResponseKeywords (Form_Question $question, Asset $parent)
	_getCaptchaDisplayKeywords ()
	_getMollomCaptchaDisplayKeywords ()

Detailed Description

Definition at line 34 of file form_email.inc.

Member Function Documentation

_getAttachments

(

)

Returns array of file attachment assetids

Returns

array public

Definition at line 388 of file form_email.inc.

_getName	(		$short_name = FALSE,
			$contextid = NULL
	)

Returns name of the asset

Parameters

boolean	$short_name	whether or not we are after the shortname or the full name
int	$contextid	what context to return the name from

Returns

string private

See Also

Asset::_getName()

Definition at line 61 of file form_email.inc.

_getThankYouKeywordReplacement

(

$keyword

)

Get appropriate keywords for Thank You bodycopy and emails

Since referral assets have always been added at the Form_Email level, additional keywords should be added here instead

Parameters

string

$keyword

keyword to replace

Returns

string

Definition at line 706 of file form_email.inc.

cloneComponents	(	&	$clone,
			$components,
			$override = FALSE
	)

Clones certain specified components of the asset

Parameters

object	&$clone	the clone asset shell
array	$components	the wanted components to clone eg. Array( 'attributes', 'metadata_schemas', 'metadata', 'workflow', 'permissions', 'data', 'content_tags', 'roles', ); or alternately Array('all');
boolean	$override	whether or not to override the existing permission, metadata schemas, workflow schemas with the new ones.

Returns

boolean public

See Also

asset::cloneComponents()

Definition at line 174 of file form_email.inc.

deleteQuestion

(

&

$question

)

delete a question to this form

Parameters

object

&$question

the question object to delete

Returns

boolean public

Definition at line 258 of file form_email.inc.

finishForm

(

)

Send all the emails when the form is completed

Returns

boolean public

Definition at line 300 of file form_email.inc.

Form_Email

(

$assetid = 0

)

Constructor

Parameters

int

$assetid

the asset id to be loaded

Definition at line 44 of file form_email.inc.

getFormHeader

(

)

Returns the header of the form, ie. the start form tags and anything else needed by them

Form Email adds a hidden URL field specifying the referral URL, which can be used by emails (in particular, generic send-to-a-friend type emails).

Returns

boolean public

Definition at line 89 of file form_email.inc.

getFormInfo

(

$html = FALSE

)

Return form information (site name, site id, page name, page id, url, submission date)

Parameters

boolean

$html

return html formatted or not

Returns

string public

Definition at line 123 of file form_email.inc.

mailReceipt

(

)

Mail a receipt to the user if a receipt email field has been assigned in Email Options

Returns

boolean public

Definition at line 340 of file form_email.inc.

mailRecipients

(

)

Send mail to recipients set in the backend

Returns

boolean public

Definition at line 373 of file form_email.inc.

performSubmissionActions

(

$before_submit = FALSE

)

Perform any submission actions that are valid and active

Parameters

boolean

$before_submit

perform action before form gets submitted?

Returns

void

Definition at line 672 of file form_email.inc.

runSelectiveEmails

(

)

Run selective emails application

Returns

boolean public

Definition at line 456 of file form_email.inc.

sendEmail	(	&	$email_format_attr,
			$replacements = Array()
	)

Common function for sending away an email format

This function automatically replaces the common Thank You/email bodycopy keywords. Additional keywords to replace can be sent through the $additional_reps parameter.

Parameters

object	&$email_format_attr	(Asset_Attribute_Email_Format) The email format to send off
array	$replacements	(string => string) Additional replacements for a certain email (eg. receipt address)

Returns

void private

Definition at line 617 of file form_email.inc.

sendToFriends

(

)

Mail a receipt to friends if a STAF field has been assigned in Email Options

Returns

boolean public

Definition at line 427 of file form_email.inc.

---

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

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