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

Inheritance diagram for eZPaymentGatewayType:

Collaboration diagram for eZPaymentGatewayType:

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 42 of file ezpaymentgatewaytype.php.

Member Function Documentation

eZPaymentGatewayType::attribute ( $ attr )

Reimplemented from eZWorkflowType.

Definition at line 146 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 105 of file ezpaymentgatewaytype.php.

eZPaymentGatewayType::attributes ( )

Reimplemented from eZWorkflowType.

Definition at line 135 of file ezpaymentgatewaytype.php.

Referenced by hasAttribute().

eZPaymentGatewayType::cleanup	(	$	process,
		$	event
	)

Delegate to eZPaymentGateway subclass.

Reimplemented from eZWorkflowType.

Definition at line 368 of file ezpaymentgatewaytype.php.

eZPaymentGatewayType::createGateway ( $ inGatewayType )

Creates and returns object of eZPaymentGateway subclass.

Definition at line 277 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 67 of file ezpaymentgatewaytype.php.

eZPaymentGatewayType::eZPaymentGatewayType ( )

Constructor.

Definition at line 52 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 386 of file ezpaymentgatewaytype.php.

eZPaymentGatewayType::getCurrentGateway ( $ event )

Returns 'current' gateway.

Definition at line 296 of file ezpaymentgatewaytype.php.

Referenced by cleanup(), and execute().

eZPaymentGatewayType::getCurrentGatewayType ( $ event )

Returns 'current' gatewaytype.

Definition at line 313 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 248 of file ezpaymentgatewaytype.php.

Referenced by attribute(), and attributeDecoder().

eZPaymentGatewayType::hasAttribute ( $ attr )

Reimplemented from eZWorkflowType.

Definition at line 141 of file ezpaymentgatewaytype.php.

eZPaymentGatewayType::initializeEvent ( $ event )

Reimplemented from eZWorkflowType.

Definition at line 377 of file ezpaymentgatewaytype.php.

eZPaymentGatewayType::loadAndRegisterBuiltInGateways ( ) [static]

Definition at line 172 of file ezpaymentgatewaytype.php.

Referenced by loadAndRegisterGateways().

eZPaymentGatewayType::loadAndRegisterExtensionGateways ( ) [static]

Definition at line 204 of file ezpaymentgatewaytype.php.

Referenced by loadAndRegisterGateways().

eZPaymentGatewayType::loadAndRegisterGateways ( ) [static]

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

Definition at line 163 of file ezpaymentgatewaytype.php.

Referenced by eZPaymentGatewayType().

eZPaymentGatewayType::needCleanup ( )

Reimplemented from eZWorkflowType.

Definition at line 359 of file ezpaymentgatewaytype.php.

eZPaymentGatewayType::registerGateway	(	$	gateway,
		$	class_name,
		$	description
	)

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

Definition at line 225 of file ezpaymentgatewaytype.php.

eZPaymentGatewayType::selectGateway ( $ event )

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 342 of file ezpaymentgatewaytype.php.

Referenced by execute().

eZPaymentGatewayType::typeFunctionalAttributes ( )

Reimplemented from eZWorkflowType.

Definition at line 130 of file ezpaymentgatewaytype.php.