Inheritance diagram for Payment_Gateway_Dps:

Public Member Functions
	__construct ($assetid=0)

	_createAdditional (&$link)

	_createBodycopy ($link_value, $content)

	_getAllowedLinks ()

	getAvailableKeywords ()

	onRequestKeywords (&$broadcaster, $vars=Array())

	printBody ()

	printBodycopy ($link_value)

	getBodycopy ($link_value)

	processPayment ($card_info)

	returnToCaller ($state='SUCCESS')

	getCardNumberKeywordReplacement ()

	getCardNameKeywordReplacement ()

	getCardStartMonthKeywordReplacement ()

	getCardStartYearKeywordReplacement ()

	getCardExpiryMonthKeywordReplacement ()

	getCardExpiryYearKeywordReplacement ()

	getCardIssueNumberKeywordReplacement ()

	getCardCv2KeywordReplacement ()

	getStreetAddress1KeywordReplacement ()

	getStreetAddress2KeywordReplacement ()

	getStreetAddress3KeywordReplacement ()

	getStreetAddress4KeywordReplacement ()

	getPostcodeKeywordReplacement ()

	getTransactionAmountKeywordReplacement ()

	getTransactionCurrencyKeywordReplacement ()

	getProcessingErrorKeywordReplacement ()

	getSubmitButtonKeywordReplacement ()

	getResetButtonKeywordReplacement ()

	getCancelButtonKeywordReplacement ()

	isError ()

	getErrorMessage ()

Public Member Functions inherited from Payment_Gateway
	create (&$link)

	_createAdditional (&$link)

Public Member Functions inherited from Page
	__construct ($assetid=0)

	_getAllowedLinks ()

	printBody ()

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 Asset
	$id = 0

	$version = ''

	$name = ''

	$short_name = ''

	$status

	$languages = ''

	$charset = ''

	$force_secure = '0'

	$created

	$created_userid

	$updated

	$updated_userid

	$published

	$published_userid

	$status_changed

	$status_changed_userid

	$_is_cacheable = FALSE

	$vars = Array()

	$_available_keywords = Array()

	$data_path_suffix = ''

	$data_path = ''

	$data_path_public = ''

	$_ser_attrs = FALSE

Protected Member Functions inherited from Payment_Gateway
	_getName ($short_name=FALSE, $contextid=NULL)

	appendPendingOrderAuditLog ($msg)

	setPendingOrderMerchantReference ($ref_no)

Detailed Description

Definition at line 32 of file payment_gateway_dps.inc.

Constructor & Destructor Documentation

__construct ( $assetid = 0 )

Constructor

Parameters

int $assetid the asset id to be loaded

Definition at line 47 of file payment_gateway_dps.inc.

Member Function Documentation

_createAdditional ( & $link )

Perform any additional processing required during the creation of this asset

Datacash Payment Gateway creates a bodycopy asset when they are created

Parameters

array &$link information used to create the initial link

Returns: boolean private

Definition at line 64 of file payment_gateway_dps.inc.

_createBodycopy	(	$link_value,
		$content
	)

Create Bodycopy

Parameters

string	$link_value	the link value of the link between this Datacash Payment Gateway asset and the new bodycopy
string	$content	the content to put into the bodycopy

Returns: string private

Definition at line 82 of file payment_gateway_dps.inc.

_getAllowedLinks ( )

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

Returns: array private

See Also: Asset::_getAllowedLinks()

Definition at line 107 of file payment_gateway_dps.inc.

getAvailableKeywords ( )

Return the available keywords

The return value is in the form:

Array(
    'keyword' => 'name',
)

Returns: array public

Definition at line 129 of file payment_gateway_dps.inc.

getBodycopy ( $link_value )

Return the bodycopy linked to this page

Returns: object public

Definition at line 320 of file payment_gateway_dps.inc.

getCancelButtonKeywordReplacement ( )

Cancel Button keyword replacement

Returns: string public

Definition at line 897 of file payment_gateway_dps.inc.

getCardCv2KeywordReplacement ( )

Card CV2 keyword replacement

Returns: string public

Definition at line 718 of file payment_gateway_dps.inc.

getCardExpiryMonthKeywordReplacement ( )

Card Expiry Month keyword replacement

Returns: string public

Definition at line 667 of file payment_gateway_dps.inc.

getCardExpiryYearKeywordReplacement ( )

Card Expiry Year keyword replacement

Returns: string public

Definition at line 684 of file payment_gateway_dps.inc.

getCardIssueNumberKeywordReplacement ( )

Card Issue Number keyword replacement

Returns: string public

Definition at line 701 of file payment_gateway_dps.inc.

getCardNameKeywordReplacement ( )

Card Name keyword replacement

Returns: string private

Definition at line 617 of file payment_gateway_dps.inc.

getCardNumberKeywordReplacement ( )

Card Number keyword replacement

Returns: string public

Definition at line 589 of file payment_gateway_dps.inc.

getCardStartMonthKeywordReplacement ( )

Card Start Month keyword replacement

Returns: string public

Definition at line 633 of file payment_gateway_dps.inc.

getCardStartYearKeywordReplacement ( )

Card Start Year keyword replacement

Returns: string public

Definition at line 650 of file payment_gateway_dps.inc.

getErrorMessage ( )

Get the error message under HTML format

Returns: string the HTML error message public

Definition at line 1066 of file payment_gateway_dps.inc.

getPostcodeKeywordReplacement ( )

Postcode keyword replacement

Returns: string private

Definition at line 803 of file payment_gateway_dps.inc.

getProcessingErrorKeywordReplacement ( )

Processing Error keyword replacement

Returns: string public

Definition at line 848 of file payment_gateway_dps.inc.

getResetButtonKeywordReplacement ( )

Reset Button keyword replacement

Returns: string public

Definition at line 881 of file payment_gateway_dps.inc.

getStreetAddress1KeywordReplacement ( )

Street Address 1 keyword replacement

Returns: string private

Definition at line 735 of file payment_gateway_dps.inc.

getStreetAddress2KeywordReplacement ( )

Street Address 2 keyword replacement

Returns: string private

Definition at line 752 of file payment_gateway_dps.inc.

getStreetAddress3KeywordReplacement ( )

Street Address 3 keyword replacement

Returns: string private

Definition at line 769 of file payment_gateway_dps.inc.

getStreetAddress4KeywordReplacement ( )

Street Address 4 keyword replacement

Returns: string private

Definition at line 786 of file payment_gateway_dps.inc.

getSubmitButtonKeywordReplacement ( )

Submit Button keyword replacement

Returns: string public

Definition at line 865 of file payment_gateway_dps.inc.

getTransactionAmountKeywordReplacement ( )

Transaction Amount keyword replacement

Returns: string public

Definition at line 820 of file payment_gateway_dps.inc.

getTransactionCurrencyKeywordReplacement ( )

Transaction Currency keyword replacement

Returns: string public

Definition at line 835 of file payment_gateway_dps.inc.

isError ( )

Check if the transaction has error

Returns: boolean public

Definition at line 1053 of file payment_gateway_dps.inc.

onRequestKeywords	(	&	$broadcaster,
			$vars = `Array()`
	)

Add valid keywords for this asset to an array of keywords when asked

Parameters

object	&$broadcaster	the asset that triggered the event
array	$vars	the vars that get submitted by the broadcaster we add keywords to the $vars['keywords'] array

Returns: boolean private

Definition at line 171 of file payment_gateway_dps.inc.

printBody ( )

Basic output function. root of output process

Returns: void public

Definition at line 185 of file payment_gateway_dps.inc.

printBodycopy ( $link_value )

Prints the front-end interface for this asset

Returns: void public

Definition at line 274 of file payment_gateway_dps.inc.

processPayment ( $card_info )

Process credit card details to gateway

Parameters

array $card_info Submitted credit card information

Returns: mixed return FALSE if the card is not valid or transaction fails, return 1 if SUCCESS, return 2 if need to REDIRECT in 3-D Secure check public

Definition at line 338 of file payment_gateway_dps.inc.

returnToCaller ( $state = 'SUCCESS' )

Returns back to e-commerce form, which called gateway

Parameters

string $state state to return

Returns: void public

Definition at line 536 of file payment_gateway_dps.inc.

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

/Users/webmaster/Desktop/squiz_matrix/packages/ecommerce/payment_gateway_types/payment_gateway_dps/payment_gateway_dps.inc

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation