eZPaymentGatewayType Class Reference

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 ()
Public Member Functions inherited from eZWorkflowEventType
	eZWorkflowEventType ($typeString, $name)
Public Member Functions inherited from eZWorkflowType
	attribute ($attr)
	attributeDecoder ($event, $attr)
	attributes ()
	cleanup ($process, $event)
	cleanupAfterRemoving ($attr=array())
	customWorkflowEventHTTPAction ($http, $action, $workflowEvent)
	eventDescription ()
	execute ($process, $event)
	eZWorkflowType ($group, $type, $groupName, $name)
	fetchHTTPInput ($http, $base, $event)
	fixupHTTPInput ($http, $base, $event)
	hasAttribute ($attr)
	initializeEvent ($event)
	isAllowed ($moduleName, $functionName, $connectType)
	needCleanup ()
	setActivationDate ($date)
	setAttribute ($attr, $value)
	setInformation ($inf)
	setTriggerTypes ($allowedTypes)
	storeDefinedEventData ($event)
	storeEventData ($event, $version)
	typeFunctionalAttributes ()
	validateHTTPInput ($http, $base, $event, &$validation)
	workflowEventContent ($event)

Static Public Member Functions
	loadAndRegisterBuiltInGateways ()
	loadAndRegisterExtensionGateways ()
	loadAndRegisterGateways ()
Static Public Member Functions inherited from eZWorkflowEventType
static	registerEventType ($typeString, $class_name)
Static Public Member Functions inherited from eZWorkflowType
static	allowedTypes ()
static	createType ($typeString)
static	fetchRegisteredTypes ()
static	loadAndRegisterAllTypes ()
static	loadAndRegisterType ($typeString)
static	registerType ($group, $type, $class_name)
static	statusName ($status)
static	statusNameMap ()
	Get status name map. More...

Public Attributes
	$logger
const	GATEWAY_NOT_SELECTED = 0
const	GATEWAY_SELECTED = 1
const	WORKFLOW_TYPE_STRING = 'ezpaymentgateway'
Public Attributes inherited from eZWorkflowType
	$ActivationDate
	$Group
	$GroupName
	$Information
	$Name
	$TriggerTypes = array( '*' => true )
	$Type
	$TypeString
const	STATUS_ACCEPTED = 1
const	STATUS_DEFERRED_TO_CRON = 3
const	STATUS_DEFERRED_TO_CRON_REPEAT = 4
const	STATUS_FETCH_TEMPLATE = 7
const	STATUS_FETCH_TEMPLATE_REPEAT = 8
const	STATUS_NONE = 0
const	STATUS_REDIRECT = 10
const	STATUS_REDIRECT_REPEAT = 11
const	STATUS_REJECTED = 2
const	STATUS_RUN_SUB_EVENT = 5
const	STATUS_WORKFLOW_CANCELLED = 6
const	STATUS_WORKFLOW_DONE = 9
const	STATUS_WORKFLOW_RESET = 12

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'.

Member Function Documentation

eZPaymentGatewayType::attribute

(

$attr

)

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.

eZPaymentGatewayType::attributes

(

)

Referenced by hasAttribute().

eZPaymentGatewayType::cleanup	(		$process,
			$event
	)

Delegate to eZPaymentGateway subclass.

eZPaymentGatewayType::createGateway

(

$inGatewayType

)

Creates and returns object of eZPaymentGateway subclass.

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.

eZPaymentGatewayType::eZPaymentGatewayType

(

)

Constructor.

eZPaymentGatewayType::fetchHTTPInput	(		$http,
			$base,
			$event
	)

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

eZPaymentGatewayType::getCurrentGateway

(

$event

)

Returns 'current' gateway.

Referenced by cleanup(), and execute().

eZPaymentGatewayType::getCurrentGatewayType

(

$event

)

Returns 'current' gatewaytype.

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).

Referenced by attribute(), and attributeDecoder().

eZPaymentGatewayType::hasAttribute

(

$attr

)

eZPaymentGatewayType::initializeEvent

(

$event

)

eZPaymentGatewayType::loadAndRegisterBuiltInGateways ( )

static

Referenced by loadAndRegisterGateways().

eZPaymentGatewayType::loadAndRegisterExtensionGateways ( )

static

Referenced by loadAndRegisterGateways().

eZPaymentGatewayType::loadAndRegisterGateways ( )

static

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

Referenced by eZPaymentGatewayType().

eZPaymentGatewayType::needCleanup

(

)

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

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

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).

Referenced by execute().

eZPaymentGatewayType::typeFunctionalAttributes

(

)

Member Data Documentation

eZPaymentGatewayType::$logger

const eZPaymentGatewayType::GATEWAY_NOT_SELECTED = 0

Referenced by execute().

const eZPaymentGatewayType::GATEWAY_SELECTED = 1

Referenced by execute().

const eZPaymentGatewayType::WORKFLOW_TYPE_STRING = 'ezpaymentgateway'

Referenced by eZPaymentGatewayType().

---

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

• ezpaymentgatewaytype.php