Settings
extends TransactionFee
in package
Class Settings
Table of Contents
- $active : bool
- This is not active by default
- $automatic_tax : bool
- $baseprice : mixed
- $connected_secret_live : string
- $connected_secret_test : string
- $error_mail : string
- $error_mail_language : string
- $gateways : array<string|int, string>
- $mode : string
- $mode : string
- Mode is set to live by default
- $prices : array<string|int, mixed>
- $private_key_live : string
- $private_key_test : string
- $public_key_live : string
- $public_key_test : string
- $recurring_gateways : array<string|int, string>
- $shared_secret_live : string
- $shared_secret_test : string
- $subscription_gateways : array<string|int, string>
- $tax_rates : array<string|int, TaxRate>
- $taxes : mixed
- $zero_amount_price_id : string
- $dynamics : array<string|int, mixed>
- __construct() : mixed
- Contract this instance
- __get() : mixed|null
- Magic getter to avoid "PHP 8.2: Dynamic Properties are deprecated"
- __isset() : bool
- Magic check to avoid "PHP 8.2: Dynamic Properties are deprecated"
- __set() : void
- Magic setter to avoid "PHP 8.2: Dynamic Properties are deprecated"
- ExternalTaxRate() : string|null
- Get the external tax rate
- PrivateKey() : string|null
- Get private key depending on mode
- PublicKey() : string|null
- Get public key depending on mode
Properties
$active
This is not active by default
public
bool
$active
= false
$automatic_tax
public
bool
$automatic_tax
The automatic tax module is enabled and can be used?
$baseprice
public
mixed
$baseprice
float
$connected_secret_live
public
string
$connected_secret_live
The shared webhook secret for live and connected accounts
$connected_secret_test
public
string
$connected_secret_test
The shared webhook secret for test and connected accounts
$error_mail
public
string
$error_mail
The mail template
$error_mail_language
public
string
$error_mail_language
Language for error mail
$gateways
public
array<string|int, string>
$gateways
The available payment methods/gateways
$mode
public
string
$mode
The mode live|test
$mode
Mode is set to live by default
public
string
$mode
= 'live'
$prices
public
array<string|int, mixed>
$prices
The price table mapping
$private_key_live
public
string
$private_key_live
The private key for live
$private_key_test
public
string
$private_key_test
The private key for test
$public_key_live
public
string
$public_key_live
The public key for live
$public_key_test
public
string
$public_key_test
The public key for test
$recurring_gateways
public
array<string|int, string>
$recurring_gateways
The available payment methods/gateways for recurring payments
$shared_secret_live
public
string
$shared_secret_live
The shared webhook secret for live
$shared_secret_test
public
string
$shared_secret_test
The shared webhook secret for test
$subscription_gateways
public
array<string|int, string>
$subscription_gateways
The available payment methods/gateways for subscriptions
$tax_rates
public
array<string|int, TaxRate>
$tax_rates
The tax rate mapping
$taxes
public
mixed
$taxes
float
$zero_amount_price_id
public
string
$zero_amount_price_id
The id of the 0 amount price
$dynamics
private
array<string|int, mixed>
$dynamics
= array()
Methods
__construct()
Contract this instance
public
__construct(object $object) : mixed
Parameters
- $object : object
Return values
mixed —__get()
Magic getter to avoid "PHP 8.2: Dynamic Properties are deprecated"
public
__get( $name) : mixed|null
Parameters
Return values
mixed|null —__isset()
Magic check to avoid "PHP 8.2: Dynamic Properties are deprecated"
public
__isset( $name) : bool
Parameters
Return values
bool —__set()
Magic setter to avoid "PHP 8.2: Dynamic Properties are deprecated"
public
__set( $name, $value) : void
Parameters
Return values
void —ExternalTaxRate()
Get the external tax rate
public
ExternalTaxRate(float $level[, string|null $date = null ][, string|null $stage = 'live' ]) : string|null
Parameters
- $level : float
- $date : string|null = null
- $stage : string|null = 'live'
Return values
string|null —PrivateKey()
Get private key depending on mode
public
PrivateKey() : string|null
Return values
string|null —PublicKey()
Get public key depending on mode
public
PublicKey() : string|null