AbstractPaymentGateway
in package
implements
PaymentGatewayInterface
Tags
Interfaces, Classes and Traits
Table of Contents
- $description : string
- Public description.
- $hasSandboxSupport : bool
- $id : string
- Unprefixed payment gateway ID.
- $isEnabled : bool
- $isInternal : bool
- If true, then don't show this payment gateway on the settings page.
- $isSandbox : bool
- $name : string
- Gateway name (label) on the settings page.
- $publicName : string
- Public name (label) shown on the frontend.
- __construct() : mixed
- enqueueScripts() : void
- An empty method is provided to add wp_enqueue_script() handlers of each of the payment methods, if necessary.
- getDescription() : string
- getFields() : array<string|int, mixed>
- getFrontendData() : array<string|int, mixed>
- getId() : string
- getMode() : string
- getName() : string
- getPublicName() : string
- isActive() : bool
- isEnabled() : bool
- isInternal() : bool
- isOnlinePayment() : bool
- isSandbox() : bool
- isSupportsSandbox() : bool
- getAdminDescription() : string
- getOption() : mixed
- getOptionName() : string
- getOptionNameRaw() : string
- isTranslatableOption() : bool
- setupProperties() : mixed
Properties
$description
Public description.
protected
string
$description
= ''
Tags
$hasSandboxSupport
protected
bool
$hasSandboxSupport
= true
Tags
$id
Unprefixed payment gateway ID.
protected
string
$id
= 'abstract'
Tags
$isEnabled
protected
bool
$isEnabled
= false
Tags
$isInternal
If true, then don't show this payment gateway on the settings page.
protected
bool
$isInternal
= false
Tags
$isSandbox
protected
bool
$isSandbox
= false
Tags
$name
Gateway name (label) on the settings page.
protected
string
$name
= 'Abstract Payment'
Tags
$publicName
Public name (label) shown on the frontend.
protected
string
$publicName
= ''
Tags
Methods
__construct()
public
__construct() : mixed
Tags
Return values
mixed —enqueueScripts()
An empty method is provided to add wp_enqueue_script() handlers of each of the payment methods, if necessary.
public
enqueueScripts() : void
Tags
Return values
void —getDescription()
public
getDescription() : string
Tags
Return values
string —getFields()
public
getFields() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —Raw field args.
getFrontendData()
public
getFrontendData() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —getId()
public
getId() : string
Tags
Return values
string —getMode()
public
getMode() : string
Tags
Return values
string —'live'|'sandbox'
getName()
public
getName() : string
Tags
Return values
string —getPublicName()
public
getPublicName() : string
Tags
Return values
string —isActive()
public
isActive() : bool
Tags
Return values
bool —Whether gateway is enabled and supports current plugin settings, like currency.
isEnabled()
public
isEnabled() : bool
Tags
Return values
bool —isInternal()
public
isInternal() : bool
Tags
Return values
bool —If true, then don't show this payment gateway on the settings page.
isOnlinePayment()
public
isOnlinePayment() : bool
Tags
Return values
bool —isSandbox()
public
isSandbox() : bool
Tags
Return values
bool —Is sandbox enabled.
isSupportsSandbox()
public
isSupportsSandbox() : bool
Tags
Return values
bool —getAdminDescription()
protected
getAdminDescription() : string
Tags
Return values
string —Payment gateway description on the top of the page, before the first field.
getOption()
protected
getOption(string $option[, mixed $default = '' ]) : mixed
Parameters
- $option : string
- $default : mixed = ''
-
Optional. '' by default.
Tags
Return values
mixed —getOptionName()
protected
getOptionName(string $option) : string
Parameters
- $option : string
Tags
Return values
string —Prefixed option name.
getOptionNameRaw()
protected
getOptionNameRaw(string $option) : string
Parameters
- $option : string
Tags
Return values
string —Unprefixed option name.
isTranslatableOption()
protected
isTranslatableOption(string $option) : bool
Parameters
- $option : string
Tags
Return values
bool —setupProperties()
protected
setupProperties() : mixed