ZenMagick 0.9.11

Frames No frames
Summary: Field | Method | Constr Detail: Field | Method | Constr
zenmagick.store.shared.services.plugins.types\ZMPaymentType
services\plugins\types\ZMPaymentType.php at line 33

Interface ZMPaymentType

ZMPaymentType

public interface ZMPaymentType

A payment type.

Author:
DerManoMann
Method Summary
string

getDescription()

Get the description.

string

getError()

Get the payment error (if any).
array

getFields()

Get the payment form fields.
string

getFormValidationJS(ZMRequest request)

Get form validation javaScript for this payment type.
int

getId()

Get the payment type id.
string

getInfo()

Get the info field.
string

getName()

Get the payment UI name.

string

getOrderFormContent(ZMRequest request)

Get the content (HTML) for the actual order form (button).
string

getOrderFormUrl(ZMRequest request)

Get the url to be used for the actual order form.

string

getTitle()

Get the payment title.

Method Detail

services\plugins\types\ZMPaymentType.php at line 66

getDescription

public string getDescription()

Get the description.

This may contain HTML, depending on the module.

Returns:
More details description.
services\plugins\types\ZMPaymentType.php at line 73

getError

public string getError()

Get the payment error (if any).

Returns:
The payment error message.
services\plugins\types\ZMPaymentType.php at line 80

getFields

public array getFields()

Get the payment form fields.

Returns:
A list of ZMPaymentField instances.
services\plugins\types\ZMPaymentType.php at line 95

getFormValidationJS

public string getFormValidationJS(ZMRequest request)

Get form validation javaScript for this payment type.

Parameters:
request - The current request.
Returns:
JavaScript code.
services\plugins\types\ZMPaymentType.php at line 39

getId

public int getId()

Get the payment type id.

Returns:
The payment type id.
services\plugins\types\ZMPaymentType.php at line 87

getInfo

public string getInfo()

Get the info field.

Returns:
Additional information or null.
services\plugins\types\ZMPaymentType.php at line 48

getName

public string getName()

Get the payment UI name.

This may contain HTML, depending on the module.

Returns:
The payment name.
services\plugins\types\ZMPaymentType.php at line 103

getOrderFormContent

public string getOrderFormContent(ZMRequest request)

Get the content (HTML) for the actual order form (button).

Parameters:
request - The current request.
Returns:
The order form content for this payment type.
services\plugins\types\ZMPaymentType.php at line 113

getOrderFormUrl

public string getOrderFormUrl(ZMRequest request)

Get the url to be used for the actual order form.

This is mostly relevant for payment types with externally hosted payment forms.

Parameters:
request - The current request.
Returns:
A url or null.
services\plugins\types\ZMPaymentType.php at line 57

getTitle

public string getTitle()

Get the payment title.

This may contain HTML, depending on the module.

Returns:
The payment title.

ZenMagick 0.9.11

Frames No frames
Summary: Field | Method | Constr Detail: Field | Method | Constr