Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Public Member Functions
Payment_Gateway_SagePay Class Reference
Inheritance diagram for Payment_Gateway_SagePay:
Payment_Gateway Page Asset MySource_Object

Public Member Functions

 __construct ($assetid=0)
 
 _createAdditional (&$link)
 
 _createBodycopy ($link_value, $content)
 
 _getAllowedLinks ()
 
 getAvailableKeywords ()
 
 onRequestKeywords (&$broadcaster, $vars=Array())
 
 getKeywordReplacement ($keyword)
 
 printBody ()
 
 printBodycopy ($link_value)
 
 getBodycopy ($link_value)
 
 processPayment ($card_info)
 
 authorizePayment ($md, $pares)
 
 returnToCaller ($state='SUCCESS', $is_in_frame=FALSE)
 
 getCardNameKeywordReplacement ()
 
 getCardNumberKeywordReplacement ()
 
 getCardStartMonthKeywordReplacement ()
 
 getCardStartMonthSelectKeywordReplacement ()
 
 getCardStartYearKeywordReplacement ()
 
 getCardStartYearSelectKeywordReplacement ($period=5)
 
 getCardExpiryMonthKeywordReplacement ()
 
 getCardExpiryMonthSelectKeywordReplacement ()
 
 getCardExpiryYearKeywordReplacement ()
 
 getCardExpiryYearSelectKeywordReplacement ($period=18)
 
 getCardIssueNumberKeywordReplacement ()
 
 getCardCv2KeywordReplacement ()
 
 getCardTypeKeywordReplacement ()
 
 getBillingFirstNamesKeywordReplacement ()
 
 getBillingSurnameKeywordReplacement ()
 
 getBillingAddress1KeywordReplacement ($line=MIN_LINE_IN_ADDRESS)
 
 getBillingAddress2KeywordReplacement ($line=MIN_LINE_IN_ADDRESS)
 
 getBillingCityKeywordReplacement ()
 
 getBillingPostcodeKeywordReplacement ()
 
 getBillingCountryKeywordReplacement ()
 
 getBillingStateKeywordReplacement ()
 
 getBillingPhoneKeywordReplacement ()
 
 getDeliveryFirstNamesKeywordReplacement ()
 
 getDeliverySurnameKeywordReplacement ()
 
 getDeliveryAddress1KeywordReplacement ($line=MIN_LINE_IN_ADDRESS)
 
 getDeliveryAddress2KeywordReplacement ($line=MIN_LINE_IN_ADDRESS)
 
 getDeliveryCityKeywordReplacement ()
 
 getDeliveryPostcodeKeywordReplacement ()
 
 getDeliveryCountryKeywordReplacement ()
 
 getDeliveryStateKeywordReplacement ()
 
 getDeliveryPhoneKeywordReplacement ()
 
 getTransactionAmountKeywordReplacement ()
 
 getProcessingErrorKeywordReplacement ()
 
 getSubmitButtonKeywordReplacement ()
 
 getResetButtonKeywordReplacement ()
 
 getCancelButtonKeywordReplacement ()
 
 getCardHolderVerificationFormKeywordReplacement ()
 
 _delivery_textbox ($name, $value)
 
 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 35 of file payment_gateway_sagepay.inc.

Constructor & Destructor Documentation

__construct (   $assetid = 0)

Constructor

Parameters
int$assetidthe asset id to be loaded

Definition at line 58 of file payment_gateway_sagepay.inc.

Member Function Documentation

_createAdditional ( &  $link)

Perform any additional processing required during the creation of this asset

SagePay Payment Gateway creates a bodycopy asset when they are created

Parameters
array&$linkinformation used to create the initial link
Returns
boolean private

Definition at line 75 of file payment_gateway_sagepay.inc.

_createBodycopy (   $link_value,
  $content 
)

Create Bodycopy

Parameters
string$link_valuethe link value of the link between this SagePay Payment Gateway asset and the new bodycopy
string$contentthe content to put into the bodycopy
Returns
string private

Definition at line 93 of file payment_gateway_sagepay.inc.

_delivery_textbox (   $name,
  $value 
)

Paint a textbox or a hidden field for delivery address components based on the hide_delivery_addr attribute

Parameters
string$nameName of the textbox or hidden field
string$valueValue of the textbox or hidden field
Returns
void private

Definition at line 1880 of file payment_gateway_sagepay.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 118 of file payment_gateway_sagepay.inc.

authorizePayment (   $md,
  $pares 
)

Authorize the payment when the user is redirected from the Access Control Server (ACS) after completing the Card Holder Verification process

Parameters
string$mdthe MD sent back by the ACS
string$paresthe Payment Authentication Response (PARes) returned by the Access Control Server (ACS)
Returns
mixed return 1 if SUCCESS; otherwise, return FALSE public

Definition at line 843 of file payment_gateway_sagepay.inc.

getAvailableKeywords ( )

Return the available keywords

The return value is in the form: 

Array(
    'keyword' => 'name',
)
Returns
array public

Definition at line 140 of file payment_gateway_sagepay.inc.

getBillingAddress1KeywordReplacement (   $line = MIN_LINE_IN_ADDRESS)

Billing Address 1 keyword replacement

Parameters
string$linethe line number of the billing address 1
Returns
string private

Definition at line 1322 of file payment_gateway_sagepay.inc.

getBillingAddress2KeywordReplacement (   $line = MIN_LINE_IN_ADDRESS)

Billing Address 2 keyword replacement

Parameters
string$linethe line number of the billing address 2
Returns
string private

Definition at line 1341 of file payment_gateway_sagepay.inc.

getBillingCityKeywordReplacement ( )

Billing City keyword replacement

Returns
string private

Definition at line 1358 of file payment_gateway_sagepay.inc.

getBillingCountryKeywordReplacement ( )

Billing Country keyword replacement

Returns
string private

Definition at line 1392 of file payment_gateway_sagepay.inc.

getBillingFirstNamesKeywordReplacement ( )

Billing First Names keyword replacement

Returns
string private

Definition at line 1286 of file payment_gateway_sagepay.inc.

getBillingPhoneKeywordReplacement ( )

Billing Phone keyword replacement

Returns
string private

Definition at line 1427 of file payment_gateway_sagepay.inc.

getBillingPostcodeKeywordReplacement ( )

Billing Postcode keyword replacement

Returns
string private

Definition at line 1375 of file payment_gateway_sagepay.inc.

getBillingStateKeywordReplacement ( )

Billing State keyword replacement

Returns
string private

Definition at line 1412 of file payment_gateway_sagepay.inc.

getBillingSurnameKeywordReplacement ( )

Billing Surname keyword replacement

Returns
string private

Definition at line 1303 of file payment_gateway_sagepay.inc.

getBodycopy (   $link_value)

Return the bodycopy linked to this page

Returns
object public

Definition at line 412 of file payment_gateway_sagepay.inc.

getCancelButtonKeywordReplacement ( )

Cancel Button keyword replacement

Returns
string public

Definition at line 1668 of file payment_gateway_sagepay.inc.

getCardCv2KeywordReplacement ( )

Card CV2 keyword replacement

Returns
string public

Definition at line 1242 of file payment_gateway_sagepay.inc.

getCardExpiryMonthKeywordReplacement ( )

Card Expiry Month keyword replacement

Returns
string public

Definition at line 1144 of file payment_gateway_sagepay.inc.

getCardExpiryMonthSelectKeywordReplacement ( )

Card Expiry Month Select keyword replacement

Returns
string public

Definition at line 1161 of file payment_gateway_sagepay.inc.

getCardExpiryYearKeywordReplacement ( )

Card Expiry Year keyword replacement

Returns
string public

Definition at line 1184 of file payment_gateway_sagepay.inc.

getCardExpiryYearSelectKeywordReplacement (   $period = 18)

Card Expiry Year Select keyword replacement

Returns
string public

Definition at line 1201 of file payment_gateway_sagepay.inc.

getCardHolderVerificationFormKeywordReplacement ( )

Card Holder Verification Form keyword replacement

Returns
string public

Definition at line 1684 of file payment_gateway_sagepay.inc.

getCardIssueNumberKeywordReplacement ( )

Card Issue Number keyword replacement

Returns
string public

Definition at line 1225 of file payment_gateway_sagepay.inc.

getCardNameKeywordReplacement ( )

Card Name keyword replacement

Returns
string private

Definition at line 1020 of file payment_gateway_sagepay.inc.

getCardNumberKeywordReplacement ( )

Card Number keyword replacement

Returns
string public

Definition at line 1035 of file payment_gateway_sagepay.inc.

getCardStartMonthKeywordReplacement ( )

Card Start Month keyword replacement

Returns
string public

Definition at line 1063 of file payment_gateway_sagepay.inc.

getCardStartMonthSelectKeywordReplacement ( )

Card Start Month Select keyword replacement

Returns
string public

Definition at line 1080 of file payment_gateway_sagepay.inc.

getCardStartYearKeywordReplacement ( )

Card Start Year keyword replacement

Returns
string public

Definition at line 1103 of file payment_gateway_sagepay.inc.

getCardStartYearSelectKeywordReplacement (   $period = 5)

Card Start Year Select keyword replacement

Returns
string public

Definition at line 1120 of file payment_gateway_sagepay.inc.

getCardTypeKeywordReplacement ( )

Card Type keyword replacement

Returns
string private

Definition at line 1259 of file payment_gateway_sagepay.inc.

getDeliveryAddress1KeywordReplacement (   $line = MIN_LINE_IN_ADDRESS)

Delivery Address 1 keyword replacement

Parameters
string$linethe line number of the delivery address 1
Returns
string private

Definition at line 1478 of file payment_gateway_sagepay.inc.

getDeliveryAddress2KeywordReplacement (   $line = MIN_LINE_IN_ADDRESS)

Delivery Address 2 keyword replacement

Parameters
string$linethe line number of the delivery address 2
Returns
string private

Definition at line 1497 of file payment_gateway_sagepay.inc.

getDeliveryCityKeywordReplacement ( )

Delivery City keyword replacement

Returns
string private

Definition at line 1514 of file payment_gateway_sagepay.inc.

getDeliveryCountryKeywordReplacement ( )

Delivery Country keyword replacement

Returns
string private

Definition at line 1548 of file payment_gateway_sagepay.inc.

getDeliveryFirstNamesKeywordReplacement ( )

Delivery First Names keyword replacement

Returns
string private

Definition at line 1442 of file payment_gateway_sagepay.inc.

getDeliveryPhoneKeywordReplacement ( )

Delivery Phone keyword replacement

Returns
string private

Definition at line 1589 of file payment_gateway_sagepay.inc.

getDeliveryPostcodeKeywordReplacement ( )

Delivery Postcode keyword replacement

Returns
string private

Definition at line 1531 of file payment_gateway_sagepay.inc.

getDeliveryStateKeywordReplacement ( )

Delivery State keyword replacement

Returns
string private

Definition at line 1574 of file payment_gateway_sagepay.inc.

getDeliverySurnameKeywordReplacement ( )

Delivery Surname keyword replacement

Returns
string private

Definition at line 1459 of file payment_gateway_sagepay.inc.

getErrorMessage ( )

Get the error message under HTML format

Returns
string the HTML error message public

Definition at line 1910 of file payment_gateway_sagepay.inc.

getKeywordReplacement (   $keyword)

Get bodycopy keyword replacement

If keyword is card_start_year_select_XX% or card_expiry_year_select_XX%, call the correct method with XX is $period parameter. Otherwise, call the parent method.

Parameters
string$keywordKeyword to find a replacement for
Returns
string public
See Also
_getKeywordReplacement

Definition at line 220 of file payment_gateway_sagepay.inc.

getProcessingErrorKeywordReplacement ( )

Processing Error keyword replacement

Returns
string public

Definition at line 1619 of file payment_gateway_sagepay.inc.

getResetButtonKeywordReplacement ( )

Reset Button keyword replacement

Returns
string public

Definition at line 1652 of file payment_gateway_sagepay.inc.

getSubmitButtonKeywordReplacement ( )

Submit Button keyword replacement

Returns
string public

Definition at line 1636 of file payment_gateway_sagepay.inc.

getTransactionAmountKeywordReplacement ( )

Transaction Amount keyword replacement

Returns
string public

Definition at line 1604 of file payment_gateway_sagepay.inc.

isError ( )

Check if the transaction has error

Returns
boolean public

Definition at line 1897 of file payment_gateway_sagepay.inc.

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

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

Parameters
object&$broadcasterthe asset that triggered the event
array$varsthe vars that get submitted by the broadcaster we add keywords to the $vars['keywords'] array
Returns
boolean private

Definition at line 200 of file payment_gateway_sagepay.inc.

printBody ( )

Basic output function. root of output process

Returns
void public

Definition at line 276 of file payment_gateway_sagepay.inc.

printBodycopy (   $link_value)

Prints the front-end interface for this asset

Returns
void public

Definition at line 366 of file payment_gateway_sagepay.inc.

processPayment (   $card_info)

Process credit card details to gateway

Parameters
array$card_infoSubmitted 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 430 of file payment_gateway_sagepay.inc.

returnToCaller (   $state = 'SUCCESS',
  $is_in_frame = FALSE 
)

Returns back to e-commerce form, which called gateway

Parameters
string$statestate to return
Returns
void public

Definition at line 958 of file payment_gateway_sagepay.inc.

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