eZPaymentGatewayType class

Data

Methods

execute(process: eZWorkflowProcess, event: eZWorkflowEven): EZ_WORKFLOW_TYPE_STATUS

Creates necessary gateway and delegate execution to it. If there are multiple gateways in eZPaymentGatewayType, shows template with a list of available gateways and asks user to choose one.

Parameters

Returns

EZ_WORKFLOW_TYPE_STATUS_REJECTED - payment is rejected by some reason.
EZ_WORKFLOW_TYPE_STATUS_ACCEPTED - payment is accepted.
EZ_WORKFLOW_TYPE_STATUS_FETCH_TEMPLATE_REPEAT - fetches template specified in 'Template' member of the process and force to repeat call to 'execute'.
EZ_WORKFLOW_TYPE_STATUS_REDIRECT_REPEAT - performs redirection to the URL specified in RedirectUrl member of the process and force to repeat call to 'execute'.

loadAndRegisterGateways()

Searches available gateways( build-in or as extensions ).

Parameters

Returns

loadAndRegisterBuiltInGateways()

Searches available built-in gateways.

Parameters

Returns

loadAndRegisterExtensionGateways()

Searches available gateways among extensions.

Parameters

Returns

registerGateway(gateway: string, class_name: string, description: string)

Each gateway must call this function.

Parameters

gateway - indentifier of the gateway.
class_name - name of the gateway class.
description - description of the gateway.

Return

getGateways(gatewaysTypes: array(string)): array

Parameters

gatewaysTypes - an array of gateways identifiers.

Returns

An array of gateways difinitions(class_name, description) by given gatewaysTypes.

createGateway(gatewayType: string): eZPaymentGateway

Parameters

gatewayType - a gateway identifier.

Returns

A eZPaymentGateway object by given gatewayType.

getCurrentGateway(event: eZWorkflowEvent): eZPaymentGateway

Parameters

Returns

Current gateway.

getCurrentGatewayType(event: eZWorkflowEvent): string

Parameters

Returns

Current gateway type(identifier).

selectGateway(event: eZWorkflowEvent): bool

Sets up current gateway.