Class Processor

Processor

XLite\Base\SuperClass

Extended by

XLite\Base\Singleton

Extended by

XLite\Base

Extended by

XLite\Model\Payment\Base\Processor

Direct known subclasses

XLite\Model\Payment\Base\Online, XLite\Model\Payment\Processor\Offline

Indirect known subclasses

XLite\Model\Payment\Base\CreditCard, XLite\Model\Payment\Base\Iframe, XLite\Model\Payment\Base\WebBased, XLite\Model\Payment\Processor\Check, XLite\Model\Payment\Processor\CreditCard, XLite\Model\Payment\Processor\PurchaseOrder

Abstract
Namespace: XLite\Model\Payment\Base
Since: 1.0.0
See: ____class_see____
Located at XLite/Model/Payment/Base/Processor.php

Methods summary
`abstract protected string`	# `doInitialPayment( )` Do initial payment Do initial payment Returns `string` Status code Since 1.0.0 See ____func_see____
`public string`	# `pay( XLite\Model\Payment\Transaction $transaction, array $request = array() )` Pay Pay Parameters `$transaction` `XLite\Model\Payment\Transaction` Transaction `$request` `array` Input data request OPTIONAL Returns `string` Since 1.0.0 See ____func_see____
`public string\|`	# `getInputTemplate( )` Get input template Get input template Returns `string\|` Since 1.0.0 See ____func_see____
`public array`	# `getInputErrors( array $data )` Get input errors Get input errors Parameters `$data` `array` Input data Returns `array` Since 1.0.0 See ____func_see____
`public string`	# `getSettingsWidget( )` Get settings widget or template Get settings widget or template Returns `string` Widget class name or template path Since 1.0.0 See ____func_see____
`public boolan`	# `hasModuleSettings( )` Payment method has settings into Module settings section Payment method has settings into Module settings section Returns `boolan` Since 1.0.0 See ____func_see____
`public boolean`	# `isConfigured( XLite\Model\Payment\Method $method )` Check - payment method is configured or not Check - payment method is configured or not Parameters `$method` `XLite\Model\Payment\Method` Payment method Returns `boolean` Since 1.0.0 See ____func_see____
`public boolean`	# `isApplicable( XLite\Model\Order $order, XLite\Model\Payment\Method $method )` Check - payment processor is applicable for specified order or not Check - payment processor is applicable for specified order or not Parameters `$order` `XLite\Model\Order` Order `$method` `XLite\Model\Payment\Method` Payment method Returns `boolean` Since 1.0.0 See ____func_see____
`public string`	# `getIconPath( XLite\Model\Order $order, XLite\Model\Payment\Method $method )` Get payemnt method icon path Get payemnt method icon path Parameters `$order` `XLite\Model\Order` Order `$method` `XLite\Model\Payment\Method` Payment method Returns `string` Since 1.0.0 See ____func_see____
`public string`	# `getCheckoutTemplate( XLite\Model\Payment\Method $method )` Get payment method row checkout template Get payment method row checkout template Parameters `$method` `XLite\Model\Payment\Method` Payment method Returns `string` Since 1.0.0 See ____func_see____
`public XLite\Model\Module`	# `getModule( )` Get processor module Get processor module Returns `XLite\Model\Module` Since 1.0.0 See ____func_see____
`protected XLite\Model\Order`	# `getOrder( )` Get current transaction order Get current transaction order Returns `XLite\Model\Order` Since 1.0.0 See ____func_see____
`protected XLite\Model\Profile`	# `getProfile( )` Get current transaction order profile Get current transaction order profile Returns `XLite\Model\Profile` Since 1.0.0 See ____func_see____
`protected mixed`	# `getSetting( string $name )` Get setting value by name Get setting value by name Parameters `$name` `string` Name Returns `mixed` Since 1.0.0 See ____func_see____
`protected`	# `saveInputData( )` Save input data Save input data Since 1.0.0 See ____func_see____
`protected`	# `setDetail( string $name, string $value, string $label = null )` Set transaction detail record Set transaction detail record Parameters `$name` `string` Code `$value` `string` Value `$label` `string` Label OPTIONAL Since 1.0.0 See ____func_see____
`protected array`	# `getInputDataLabels( )` Get input data labels list Get input data labels list Returns `array` Since 1.0.0 See ____func_see____
`protected array`	# `getInputDataAccessLevels( )` Get input data access levels list Get input data access levels list Returns `array` Since 1.0.0 See ____func_see____
`protected array`	# `getAllowedCurrencies( XLite\Model\Payment\Method $method )` Get allowed currencies Get allowed currencies Parameters `$method` `XLite\Model\Payment\Method` Payment method Returns `array` Since 1.0.9 See ____func_see____

Methods inherited from XLite\Base
`__call(), __get(), get(), getComplex(), is(), isComplex(), set(), setComplex(), setProperties()`

Methods inherited from XLite\Base\Singleton
`getInstance(), resetInstance()`

Methods inherited from XLite\Base\SuperClass
`__construct(), doDie(), t()`

Constants summary
`string`	`PROLONGATION`	`'R'`	# Payment procedure result codes Payment procedure result codes
`string`	`SILENT`	`'W'`	#
`string`	`SEPARATE`	`'E'`	#
`string`	`COMPLETED`	`'S'`	#
`string`	`PENDING`	`'P'`	#
`string`	`FAILED`	`'F'`	#

Properties summary
`protected XLite\Model\Payment\Transaction`	`$transaction`		# Transaction (cache) Transaction (cache) Since 1.0.0 See ____var_see____
`protected array`	`$request`		# Request cell with transaction input data Request cell with transaction input data Since 1.0.0 See ____var_see____

Properties inherited from XLite\Base
`$singletons`

Properties inherited from XLite\Base\Singleton
`$instances`