eZRedirectGateway class

This is a base class for payment gateways which supports redirection to a payment site. Never create objects of this class. Instead you have to create your own class which is inherited from this class and override execute, cleanup, createPaymentObject, createRedirectionURL functions.

Data

Methods

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

Calls createPaymentObject function to create a object of eZPaymentObject class which stores information about payment, prepares URL to redirect by calling createResirectionURL function and performs redirection to the specified URL.

Parameters

Returns

EZ_WORKFLOW_TYPE_STATUS_REDIRECT_REPEAT - to perform rediretion.
EZ_WORKFLOW_TYPE_STATUS_REJECTED - if some error occured.
EZ_WORKFLOW_TYPE_STATUS_ACCEPTED - if payment was done properly.

createPaymentObject(processID: integer, orderID:integer )

Creates instance of subclass of eZPaymentObject which stores information about payment processing(orderID, workflowID). Must be overridden in subclass.

Parameters

Returns

A instance of eZPaymentObject subclass.

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

Removes temporary eZPaymentObject from database.

Parameters

Returns

createRedirectionURL(process: eZWorkflowProcess): string

Creates redirection url to a payment site. Must be overridden in subclass.