eZ Publish  [trunk]
eZPaymentGatewayType Class Reference

Interface for different types of payment gateways. More...

+ Inheritance diagram for eZPaymentGatewayType:
+ Collaboration diagram for eZPaymentGatewayType:

List of all members.

Public Member Functions

 attribute ($attr)
 attributeDecoder ($event, $attr)
 attributes ()
 cleanup ($process, $event)
 createGateway ($inGatewayType)
 execute ($process, $event)
 eZPaymentGatewayType ()
 fetchHTTPInput ($http, $base, $event)
 getCurrentGateway ($event)
 getCurrentGatewayType ($event)
 getGateways ($gatewaysTypes)
 hasAttribute ($attr)
 initializeEvent ($event)
 needCleanup ()
 registerGateway ($gateway, $class_name, $description)
 selectGateway ($event)
 typeFunctionalAttributes ()

Static Public Member Functions

 loadAndRegisterBuiltInGateways ()
 loadAndRegisterExtensionGateways ()
 loadAndRegisterGateways ()

Public Attributes

 $logger
const GATEWAY_NOT_SELECTED = 0
const GATEWAY_SELECTED = 1
const WORKFLOW_TYPE_STRING = 'ezpaymentgateway'

Detailed Description

Interface for different types of payment gateways.

Allows use multiple payment gateways in workflow. Allows user to choose necessary gateway type 'on the fly'.

Definition at line 19 of file ezpaymentgatewaytype.php.


Member Function Documentation

Reimplemented from eZWorkflowType.

Definition at line 123 of file ezpaymentgatewaytype.php.

eZPaymentGatewayType::attributeDecoder ( event,
attr 
)

Attributes. There are three types of gateways in eZPaymentGatewayType. 'Available' gateways - gateways that were installed in the eZPublish (as extensions, build-in); 'Selected' gateways - gateways that were selected for this instance of eZPaymentGatewayType; 'Current' gateway - through this gateway payment will be made.

Reimplemented from eZWorkflowType.

Definition at line 82 of file ezpaymentgatewaytype.php.

Reimplemented from eZWorkflowType.

Definition at line 112 of file ezpaymentgatewaytype.php.

Referenced by hasAttribute().

eZPaymentGatewayType::cleanup ( process,
event 
)

Delegate to eZPaymentGateway subclass.

Reimplemented from eZWorkflowType.

Definition at line 345 of file ezpaymentgatewaytype.php.

Creates and returns object of eZPaymentGateway subclass.

Definition at line 254 of file ezpaymentgatewaytype.php.

Referenced by getCurrentGateway().

eZPaymentGatewayType::execute ( process,
event 
)

Creates necessary gateway and delegate execution to it. If there are multiple gateways in eZPaymentGatewayType, fetches template with list of 'selected'(see. 'attributes' section) gateways and asks user to choose one.

Reimplemented from eZWorkflowType.

Definition at line 44 of file ezpaymentgatewaytype.php.

Constructor.

Definition at line 29 of file ezpaymentgatewaytype.php.

eZPaymentGatewayType::fetchHTTPInput ( http,
base,
event 
)

Sets 'selected' gateways. -1 means 'Any' - all 'available' gateways becomes 'selected'.

Reimplemented from eZWorkflowType.

Definition at line 363 of file ezpaymentgatewaytype.php.

Returns 'current' gateway.

Definition at line 273 of file ezpaymentgatewaytype.php.

Referenced by cleanup(), and execute().

Returns 'current' gatewaytype.

Definition at line 290 of file ezpaymentgatewaytype.php.

Referenced by getCurrentGateway().

eZPaymentGatewayType::getGateways ( gatewaysTypes)

Returns an array of gateways difinitions( class_name, description ) by 'gatewaysTypes'( array of 'gateway' values that were passed to 'registerGateway' function).

Definition at line 225 of file ezpaymentgatewaytype.php.

Referenced by attribute(), and attributeDecoder().

Reimplemented from eZWorkflowType.

Definition at line 118 of file ezpaymentgatewaytype.php.

Reimplemented from eZWorkflowType.

Definition at line 354 of file ezpaymentgatewaytype.php.

Searches 'available' gateways( built-in or as extensions ).

Definition at line 140 of file ezpaymentgatewaytype.php.

Referenced by eZPaymentGatewayType().

Reimplemented from eZWorkflowType.

Definition at line 336 of file ezpaymentgatewaytype.php.

eZPaymentGatewayType::registerGateway ( gateway,
class_name,
description 
)

Each gateway must call this function to become 'available'.

Definition at line 202 of file ezpaymentgatewaytype.php.

Sets 'current' gateway from 'selected' gateways. If 'selected' is just one, it becomes 'current'. Else user have to choose some( appropriate template will be shown).

Definition at line 319 of file ezpaymentgatewaytype.php.

Referenced by execute().


Member Data Documentation

eZPaymentGatewayType::$logger

Definition at line 379 of file ezpaymentgatewaytype.php.

Definition at line 22 of file ezpaymentgatewaytype.php.

Referenced by execute().

Definition at line 23 of file ezpaymentgatewaytype.php.

Referenced by execute().

const eZPaymentGatewayType::WORKFLOW_TYPE_STRING = 'ezpaymentgateway'

Definition at line 21 of file ezpaymentgatewaytype.php.

Referenced by eZPaymentGatewayType().


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