Inheritance diagram for Form_Ecommerce:

Public Member Functions
	Form_Ecommerce ($assetid=0)

	_createAdditional (&$link)

	_createBodycopies ()

	_getAllowedLinks ()

	_isAllowedQuestionType ($type='')

	_isAllowedPassThroughQuestionType ($type='')

	_getEcommerceRule ($name='')

	_setEcommerceRule ($name, $value)

	printStandard ()

	_logOrderToFile ()

	printBody ()

	printFormView ()

	getKeywordReplacement ($keyword)

	isAllowedQuestionId ($question_id)

&	getAllQuestionsCached ()

	_getCommonFormKeywordReplacements ()

&	getBodycopy ($bodycopy)

	_getFormBodycopyKeywords ()

	_getConfirmationBodycopyKeywords ()

	_getReceiptBodycopyKeywords ()

&	createSubmission ()

	_getReceiptHeader ($as_html=TRUE)

	printSummary ($as_html=FALSE)

	processForm ()

	_saveOrderAsset ()

&	createOrder ()

	_getReceipt ($as_html=TRUE)

	_makeOrder ()

	_saveOrder ()

	_readOrder ()

	_deleteOrderFile ()

	_getOrderFileName ($order_no=FALSE)

	printConfirmationView ()

	printReceiptView ()

	_getParentPageAssetId ()

&	_getParentPageAsset ()

	getUrl ()

	_getThankYouBodycopyKeywords ()

	getConfirmTextKeywordReplacement ()

	getCancelTextKeywordReplacement ()

	getConfirmUrlKeywordReplacement ()

	getCancelUrlKeywordReplacement ()

	getOrderItemCountKeywordReplacement ()

	getOrderTotalKeywordReplacement ()

	getOrderTotalDiscountKeywordReplacement ()

	getOrderTotalBeforeDiscountKeywordReplacement ()

	getOrderTotalExcludingTaxKeywordReplacement ()

	getOrderTotalTaxKeywordReplacement ()

	getOrderTaxableTotalKeywordReplacement ()

	getOrderTaxableItemCountKeywordReplacement ()

	getTaxRateKeywordReplacement ()

	getTaxNameKeywordReplacement ()

	getOrderItemListKeywordReplacement ()

	getOrderPurchasableAssetListKeywordReplacement ()

	getItemListingKeywordReplacement ()

	getTaxableItemStringKeywordReplacement ()

	getCurrencySignKeywordReplacement ()

	getTransactionNumberKeywordReplacement ()

	getTransactionStatusKeywordReplacement ()

	getTransactionTypeKeywordReplacement ()

	getTransactionTimeKeywordReplacement ()

	getTransactionAmountKeywordReplacement ()

	getTransactionCardNumberKeywordReplacement ()

	getTransactionBillingNameKeywordReplacement ()

	getTransactionBillingAddressKeywordReplacement ()

	getTransactionDeliveryNameKeywordReplacement ()

	getTransactionDeliveryAddressKeywordReplacement ()

	getOrderNumberKeywordReplacement ()

&	getCurrentOrderAsset ()

	_getAssetItems ()

	_clearAssetItems ()

	_addAssetItem ($assetid, $quantity=1)

	_getAssetItemPromotionalCodes ()

	_clearAssetItemPromotionalCodes ()

	_addAssetItemPromotionalCode ($assetid, $promo_code)

	_getPromotionalCodeDiscount ($promo_code_assetid, $price, $quantity)

	_getTotal ()

	_getTotalDiscount ()

	_getTaxableTotal ()

	_getTaxRate ()

	_getTaxTotal ()

	_getOrderItems ()

	_getPurchasableAssetPrice (&$asset)

	_getPurchasableAssetName (&$asset)

	_getPassThroughVars ()

	_isPurchasableAsset (&$asset)

	_isPurchasableAssetTaxable (&$asset)

	_isPurchasableAssetQuantityAllowed (&$asset)

	_isPurchasableAssetPromotable (&$asset)

	_getPromotionalCodeAsset (&$asset, $promo_code)

	_formatPriceAmount ($amount=0)

	_isItemTaxable ($item_id)

	_getLogFileName ()

	_getLogFilePath ()

	_log ($string='')

Public Member Functions inherited from Form_Email
	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 ()

Data Fields
	$confirm_view = 'confirmation'

	$process_view = 'process'

	$receipt_view = 'receipt'

	$_bodycopies = Array('Form', 'Confirmation', 'Receipt')

Additional Inherited Members
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 37 of file form_ecommerce.inc.

Member Function Documentation

_addAssetItem	(	$assetid,
		$quantity = `1`
	)

Adds an asset item to order

Parameters

string	$assetid	Asset ID to add
int	$quantity	Quantity of asset to add

Returns: string private

Definition at line 2116 of file form_ecommerce.inc.

_addAssetItemPromotionalCode	(	$assetid,
		$promo_code
	)

Adds a promotional code asset ID to a purchasable asset

Parameters

string	$assetid	Asset ID of the purchasable asset to add
string	$promo_code	The code of the promotional code asset

Returns: void private

Definition at line 2185 of file form_ecommerce.inc.

_clearAssetItemPromotionalCodes ( )

Clear the list of promotional code assets on order

Returns: void private

Definition at line 2169 of file form_ecommerce.inc.

_clearAssetItems ( )

Clear the list of assets on order

Returns: string private

Definition at line 2100 of file form_ecommerce.inc.

_createAdditional ( & $link )

Do extra processing when creating

Parameters

array &$link link

Returns: boolean private

Definition at line 86 of file form_ecommerce.inc.

_createBodycopies ( )

Creates the necessary bodycopies

Returns: boolean private

Definition at line 99 of file form_ecommerce.inc.

_deleteOrderFile ( )

Delete file with order

Returns: boolean private

See Also: _readOrder()

Definition at line 1365 of file form_ecommerce.inc.

_formatPriceAmount ( $amount = 0 )

Format price amount with 2 decimals

Parameters

string $amount amount to format

Returns: string private

Definition at line 2536 of file form_ecommerce.inc.

_getAllowedLinks ( )

Returns an array of all the permitted link type, the type asset and the cardinality

Returns: array private

See Also: Asset::_getAllowLinks()

Definition at line 119 of file form_ecommerce.inc.

_getAssetItemPromotionalCodes ( )

Get the list of promotional code assets on order

Returns: array private

Definition at line 2151 of file form_ecommerce.inc.

_getAssetItems ( )

Get the list of assets on order

Returns: string private

Definition at line 2083 of file form_ecommerce.inc.

_getCommonFormKeywordReplacements ( )

Gets replacements for question keywords

TODO: Move this into the local getKeywordReplacement function

Returns: void public

Definition at line 807 of file form_ecommerce.inc.

_getConfirmationBodycopyKeywords ( )

Get keywords for Confirmation bodycopy

Returns: array private

Definition at line 882 of file form_ecommerce.inc.

_getEcommerceRule ( $name = '' )

Return question rule for e-commerce form

Parameters

string $name question type code

Returns: boolean public

Definition at line 189 of file form_ecommerce.inc.

_getFormBodycopyKeywords ( )

Get keywords for Form bodycopy

Returns: array private

Definition at line 869 of file form_ecommerce.inc.

_getLogFileName ( )

Get the filename of log file

Returns: string private

Definition at line 2566 of file form_ecommerce.inc.

_getLogFilePath ( )

Get the path to log file

Parameters

string $string string to log

Returns: string private

Definition at line 2580 of file form_ecommerce.inc.

_getOrderFileName ( $order_no = FALSE )

Return file name for order file

Parameters

string $order_no id of the saved file

Returns: string private

See Also: _saveOrder(); _readOrder(); _deleteOrderFile()

Definition at line 1385 of file form_ecommerce.inc.

_getOrderItems ( )

Get the itesm being ordered

Returns: array private

Definition at line 2329 of file form_ecommerce.inc.

& _getParentPageAsset ( )

Get parent page asset

Returns: object private

Definition at line 1472 of file form_ecommerce.inc.

_getParentPageAssetId ( )

Get parent page asset id

Returns: string private

Definition at line 1451 of file form_ecommerce.inc.

_getPassThroughVars ( )

Get the pass through variables under key - value pair array

Returns: array private

Definition at line 2390 of file form_ecommerce.inc.

_getPromotionalCodeAsset	(	&	$asset,
			$promo_code
	)

Return the promotional code asset if it is linked to the passed asset and has the promotional code matching the passed promotional code string

Parameters

object	&$asset	The asset to get promotional code asset from
string	$promo_code	The promotional code string to search

Returns: mixed private

Definition at line 2511 of file form_ecommerce.inc.

_getPromotionalCodeDiscount	(	$promo_code_assetid,
		$price,
		$quantity
	)

Get the discount of promotional code on an asset with price and quantity

Parameters

string	$promo_code_assetid	Asset ID of the promotional code
float	$price	The price of the asset to apply the promotional code
int	$quantity	The quantity of the asset to apply the promtional code

Returns: float private

Definition at line 2223 of file form_ecommerce.inc.

_getPurchasableAssetName ( & $asset )

Get the name of purchasable asset

Parameters

object &$asset asset to check

Returns: string private

Definition at line 2370 of file form_ecommerce.inc.

_getPurchasableAssetPrice ( & $asset )

Get the price of purchasable asset

Parameters

object &$asset asset to check

Returns: string private

Definition at line 2350 of file form_ecommerce.inc.

_getReceipt ( $as_html = TRUE )

Format reciept values into table for nice output

Parameters

boolean $as_html whether to get HTML copy or note

Returns: string private

Definition at line 1146 of file form_ecommerce.inc.

_getReceiptBodycopyKeywords ( )

Get keywords for Receipt bodycopy

Returns: array private

Definition at line 895 of file form_ecommerce.inc.

_getReceiptHeader ( $as_html = TRUE )

Makes Receipt Header

Parameters

boolean $as_html whether to get HTML copy or note

Returns: string public

Definition at line 923 of file form_ecommerce.inc.

_getTaxableTotal ( )

Get taxable total

Part of total that inicludes tax

Returns: string private

Definition at line 2280 of file form_ecommerce.inc.

_getTaxRate ( )

Get the current tax rate

Returns: string private

Definition at line 2298 of file form_ecommerce.inc.

_getTaxTotal ( )

Get the total tax amount in current state

Returns: string private

Definition at line 2311 of file form_ecommerce.inc.

_getThankYouBodycopyKeywords ( )

Get keywords for thank you bodycopy

Returns: array private

Definition at line 1519 of file form_ecommerce.inc.

_getTotal ( )

Get the total in current order

Returns: string private

Definition at line 2241 of file form_ecommerce.inc.

_getTotalDiscount ( )

Get the total discount in current order

Returns: string private

Definition at line 2259 of file form_ecommerce.inc.

_isAllowedPassThroughQuestionType ( $type = '' )

Check if question type can be used for pass through variable

Parameters

string $type question type code

Returns: boolean public

Definition at line 161 of file form_ecommerce.inc.

_isAllowedQuestionType ( $type = '' )

Check if question type can be used for e-commerce

Parameters

string $type question type code

Returns: boolean public

Definition at line 136 of file form_ecommerce.inc.

_isItemTaxable ( $item_id )

True if passed item id is taxable

Parameters

string $item_id id of item to test

Returns: boolean private

Definition at line 2551 of file form_ecommerce.inc.

_isPurchasableAsset ( & $asset )

True if passed asset is purchasable

Parameters

object &$asset asset to check

Returns: boolean private

Definition at line 2438 of file form_ecommerce.inc.

_isPurchasableAssetPromotable ( & $asset )

True if the passed asset is promotable

Parameters

object &$asset asset to check

Returns: boolean private

Definition at line 2492 of file form_ecommerce.inc.

_isPurchasableAssetQuantityAllowed ( & $asset )

True if multiples of passed asset can be purchased

Parameters

object &$asset asset to check

Returns: boolean private

Definition at line 2474 of file form_ecommerce.inc.

_isPurchasableAssetTaxable ( & $asset )

True if passed asset is taxable

Parameters

object &$asset asset to check

Returns: boolean private

Definition at line 2456 of file form_ecommerce.inc.

_log ( $string = '' )

Writes a string to log file

Parameters

string $string string to log

Returns: boolean private

Definition at line 2595 of file form_ecommerce.inc.

_logOrderToFile ( )

Log Order To File

Returns: void private

Definition at line 506 of file form_ecommerce.inc.

_makeOrder ( )

Generates order array, which contains all necessary information for payment processing

Returns: array private

Definition at line 1193 of file form_ecommerce.inc.

_readOrder ( )

Read order from the file

Returns: array private

Definition at line 1347 of file form_ecommerce.inc.

_saveOrder ( )

Save order into file, to prevent losing information in case of session dying

Returns: boolean private

Definition at line 1331 of file form_ecommerce.inc.

_saveOrderAsset ( )

Brings the submission asset up-to-date with the current state

Returns: void public

Definition at line 1013 of file form_ecommerce.inc.

_setEcommerceRule	(	$name,
		$value
	)

Save one rule

Parameters

string	$name	rule name - question id
mixed	$value	rule contents

Returns: boolean private

Definition at line 208 of file form_ecommerce.inc.

& createOrder ( )

creates a new Order object

Returns: object public

Definition at line 1066 of file form_ecommerce.inc.

& createSubmission ( )

creates a new submission object

Returns: object public

Definition at line 908 of file form_ecommerce.inc.

Form_Ecommerce ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 71 of file form_ecommerce.inc.

& getAllQuestionsCached ( )

Gets a list of all questions in the form (cached)

Caches the output of getAllQuestions in tmp vars to avoid memory problems with arrays

Returns: array public

Definition at line 786 of file form_ecommerce.inc.

& getBodycopy ( $bodycopy )

Get bodycopy by name

Parameters

string $bodycopy code of bodycopy to print

Returns: array private

Definition at line 848 of file form_ecommerce.inc.

getCancelTextKeywordReplacement ( )

Cancel Text keyword replacement

Returns: string private

Definition at line 1571 of file form_ecommerce.inc.

getCancelUrlKeywordReplacement ( )

Cancel URL keyword replacement

Returns: string private

Definition at line 1600 of file form_ecommerce.inc.

getConfirmTextKeywordReplacement ( )

Confirm Text keyword replacement

Returns: string private

Definition at line 1558 of file form_ecommerce.inc.

getConfirmUrlKeywordReplacement ( )

Confirm URL keyword replacement

Returns: string private

Definition at line 1584 of file form_ecommerce.inc.

getCurrencySignKeywordReplacement ( )

Currency Sign keyword replacement

Returns: string private

Definition at line 1897 of file form_ecommerce.inc.

& getCurrentOrderAsset ( )

Get the order asset

Returns: object private

Definition at line 2057 of file form_ecommerce.inc.

getItemListingKeywordReplacement ( )

Item List keyword replacement

Returns: string private

Definition at line 1862 of file form_ecommerce.inc.

getKeywordReplacement ( $keyword )

Keyword replacement processor

Parameters

string $keyword keyword to find a replacement for

Returns: string public

Definition at line 662 of file form_ecommerce.inc.

getOrderItemCountKeywordReplacement ( )

Order Item Count keyword replacement

Returns: string private

Definition at line 1615 of file form_ecommerce.inc.

getOrderItemListKeywordReplacement ( )

Order Item List keyword replacement

Returns: string private

Definition at line 1778 of file form_ecommerce.inc.

getOrderNumberKeywordReplacement ( )

Order Number keyword replacement

Returns: string private

Definition at line 2041 of file form_ecommerce.inc.

getOrderPurchasableAssetListKeywordReplacement ( )

Order Purchasable Asset List keyword replacement

Returns: string private

Definition at line 1815 of file form_ecommerce.inc.

getOrderTaxableItemCountKeywordReplacement ( )

Order Taxable Item Count keyword replacement

Returns: string private

Definition at line 1734 of file form_ecommerce.inc.

getOrderTaxableTotalKeywordReplacement ( )

Order Taxable Total keyword replacement

Returns: string private

Definition at line 1719 of file form_ecommerce.inc.

getOrderTotalBeforeDiscountKeywordReplacement ( )

Order Total Before Discount keyword replacement

Returns: string private

Definition at line 1666 of file form_ecommerce.inc.

getOrderTotalDiscountKeywordReplacement ( )

Order Total Discount keyword replacement

Returns: string private

Definition at line 1650 of file form_ecommerce.inc.

getOrderTotalExcludingTaxKeywordReplacement ( )

Order Total Excluding Tax keyword replacement

Returns: string private

Definition at line 1685 of file form_ecommerce.inc.

getOrderTotalKeywordReplacement ( )

Order Total keyword replacement

Returns: string private

Definition at line 1634 of file form_ecommerce.inc.

getOrderTotalTaxKeywordReplacement ( )

Order Total Tax keyword replacement

Returns: string private

Definition at line 1704 of file form_ecommerce.inc.

getTaxableItemStringKeywordReplacement ( )

Taxable Item String keyword replacement

Returns: string private

Definition at line 1884 of file form_ecommerce.inc.

getTaxNameKeywordReplacement ( )

Tax Name keyword replacement

Returns: string private

Definition at line 1765 of file form_ecommerce.inc.

getTaxRateKeywordReplacement ( )

Tax Rate keyword replacement

Returns: string private

Definition at line 1752 of file form_ecommerce.inc.

getTransactionAmountKeywordReplacement ( )

Transaction Amount keyword replacement

Returns: string private

Definition at line 1962 of file form_ecommerce.inc.

getTransactionBillingAddressKeywordReplacement ( )

Transaction Billing Address keyword replacement

Returns: string private

Definition at line 2002 of file form_ecommerce.inc.

getTransactionBillingNameKeywordReplacement ( )

Transaction Billing Name keyword replacement

Returns: string private

Definition at line 1989 of file form_ecommerce.inc.

getTransactionCardNumberKeywordReplacement ( )

Transaction Card Number keyword replacement

Returns: string private

Definition at line 1976 of file form_ecommerce.inc.

getTransactionDeliveryAddressKeywordReplacement ( )

Transaction Delivery Address keyword replacement

Returns: string private

Definition at line 2028 of file form_ecommerce.inc.

getTransactionDeliveryNameKeywordReplacement ( )

Transaction Delivery Name keyword replacement

Returns: string private

Definition at line 2015 of file form_ecommerce.inc.

getTransactionNumberKeywordReplacement ( )

Transaction Number keyword replacement

Returns: string private

Definition at line 1910 of file form_ecommerce.inc.

getTransactionStatusKeywordReplacement ( )

Transaction Status keyword replacement

Returns: string private

Definition at line 1923 of file form_ecommerce.inc.

getTransactionTimeKeywordReplacement ( )

Transaction Time keyword replacement

Returns: string private

Definition at line 1949 of file form_ecommerce.inc.

getTransactionTypeKeywordReplacement ( )

Transaction Type keyword replacement

Returns: string private

Definition at line 1936 of file form_ecommerce.inc.

getUrl ( )

Get URL

Returns url to the parent page asset

Returns: string private

Definition at line 1494 of file form_ecommerce.inc.

isAllowedQuestionId ( $question_id )

Checks if a passed question ID belongs to this form

Requires a full asset id

Parameters

string $question_id question id to check

Returns: boolean public

Definition at line 770 of file form_ecommerce.inc.

printBody ( )

Called by the design to print the body of this asset

Returns: void public

Definition at line 580 of file form_ecommerce.inc.

printConfirmationView ( )

Print Confirmation View

Returns: void public

Definition at line 1407 of file form_ecommerce.inc.

printFormView ( )

Prints current form

Returns: void public

Definition at line 593 of file form_ecommerce.inc.

printReceiptView ( )

Print receipt view

Returns: void private

Definition at line 1429 of file form_ecommerce.inc.

printStandard ( )

Main controller for this asset

This function determines what action to take next, based on the various request parameters and statuses of various actions

Returns: boolean public

Definition at line 231 of file form_ecommerce.inc.

printSummary ( $as_html = FALSE )

Print Summary of the submission

Overridden parent function to include the receipt information

Parameters

boolean $as_html flag whether to print as HTML

Returns: void public

Definition at line 980 of file form_ecommerce.inc.

processForm ( )

processes the form and returns TRUE or FALSE depending on whether form processed successfully

Returns: boolean public

Definition at line 1000 of file form_ecommerce.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/ecommerce/form/form_ecommerce/form_ecommerce.inc

Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Function Documentation