Configuration
in package
Warning:
This class subject to change without prior notice, Please dont use this class directly.
PHP version 5
Tags
Table of Contents
- $authScheme1 : mixed
- $authScheme2 : mixed
- $authScheme3 : mixed
- $accessToken : string
- Access token for OAuth
- $apiKeyPrefixes : array<string|int, string>
- Associate array to store API prefix (e.g. Bearer)
- $apiKeys : array<string|int, string>
- Associate array to store API key(s)
- $authScheme : string
- The AuthScheme used for autherization caculation.
- $clientApiKey : string
- The apiKey assigned by Orbipay to the client.
- $clientKey : string
- The unique identifier assigned by Orbipay to the client.
- $clientSignatureKey : string
- Secret key used to compute the hash
- $debug : bool
- Debug switch (default set to false)
- $debugFile : string
- Debug file location (log to STDOUT by default)
- $host : string
- The host
- $password : string
- Password for HTTP basic authentication
- $tempFolderPath : string
- Debug file location (log to STDOUT by default)
- $userAgent : string
- User agent of the HTTP request, set to "PHP-Swagger" by default
- $username : string
- Username for HTTP basic authentication
- $defaultConfiguration : mixed
- __construct() : mixed
- Constructor
- getAccessToken() : string
- Gets the access token for OAuth
- getApiKey() : string
- Gets API key
- getApiKeyPrefix() : string
- Gets API key prefix
- getApiKeyWithPrefix() : string
- Get API key (with prefix if set)
- getAuthScheme() : string
- getClientApiKey() : string
- getClientKey() : string
- getClientSignatureKey() : string
- getDebug() : bool
- Gets the debug flag
- getDebugFile() : string
- Gets the debug file
- getDefaultConfiguration() : Configuration
- Gets the default configuration instance
- getHost() : string
- Gets the host
- getPassword() : string
- Gets the password for HTTP basic authentication
- getTempFolderPath() : string
- Gets the temp folder path
- getUserAgent() : string
- Gets the user agent of the api client
- getUsername() : string
- Gets the username for HTTP basic authentication
- setAccessToken() : $this
- Sets the access token for OAuth
- setApiKey() : $this
- Sets API key
- setApiKeyPrefix() : $this
- Sets the prefix for API key (e.g. Bearer)
- setAuthScheme() : mixed
- setClientApiKey() : mixed
- setClientKey() : mixed
- setClientSignatureKey() : mixed
- setDebug() : $this
- Sets debug flag
- setDebugFile() : $this
- Sets the debug file
- setDefaultConfiguration() : void
- Sets the detault configuration instance
- setHost() : $this
- Sets the host
- setPassword() : $this
- Sets the password for HTTP basic authentication
- setTempFolderPath() : $this
- Sets the temp folder path
- setUserAgent() : $this
- Sets the user agent of the api client
- setUsername() : $this
- Sets the username for HTTP basic authentication
- toDebugReport() : string
- Gets the essential information for debugging
Properties
$authScheme1
public
mixed
$authScheme1
= "OPAY1-HMAC-SHA256"
$authScheme2
public
mixed
$authScheme2
= "OPAY2-HMAC-SHA256"
$authScheme3
public
mixed
$authScheme3
= "OPAY3-HMAC-SHA256"
$accessToken
Access token for OAuth
protected
string
$accessToken
= ''
$apiKeyPrefixes
Associate array to store API prefix (e.g. Bearer)
protected
array<string|int, string>
$apiKeyPrefixes
= []
$apiKeys
Associate array to store API key(s)
protected
array<string|int, string>
$apiKeys
= []
$authScheme
The AuthScheme used for autherization caculation.
protected
string
$authScheme
$clientApiKey
The apiKey assigned by Orbipay to the client.
protected
string
$clientApiKey
$clientKey
The unique identifier assigned by Orbipay to the client.
protected
string
$clientKey
= ''
$clientSignatureKey
Secret key used to compute the hash
protected
string
$clientSignatureKey
= ''
$debug
Debug switch (default set to false)
protected
bool
$debug
= false
$debugFile
Debug file location (log to STDOUT by default)
protected
string
$debugFile
= 'php://output'
$host
The host
protected
string
$host
= 'https://api.orbipay.com/payments/v1'
$password
Password for HTTP basic authentication
protected
string
$password
= ''
$tempFolderPath
Debug file location (log to STDOUT by default)
protected
string
$tempFolderPath
$userAgent
User agent of the HTTP request, set to "PHP-Swagger" by default
protected
string
$userAgent
= 'orbipay-paymentsapi-client/1.11.0/php'
$username
Username for HTTP basic authentication
protected
string
$username
= ''
$defaultConfiguration
private
static mixed
$defaultConfiguration
Methods
__construct()
Constructor
public
__construct() : mixed
Return values
mixed —getAccessToken()
Gets the access token for OAuth
public
getAccessToken() : string
Return values
string —Access token for OAuth
getApiKey()
Gets API key
public
getApiKey(string $apiKeyIdentifier) : string
Parameters
- $apiKeyIdentifier : string
-
API key identifier (authentication scheme)
Return values
string —API key or token
getApiKeyPrefix()
Gets API key prefix
public
getApiKeyPrefix(string $apiKeyIdentifier) : string
Parameters
- $apiKeyIdentifier : string
-
API key identifier (authentication scheme)
Return values
string —getApiKeyWithPrefix()
Get API key (with prefix if set)
public
getApiKeyWithPrefix(string $apiKeyIdentifier) : string
Parameters
- $apiKeyIdentifier : string
-
name of apikey
Return values
string —API key with the prefix
getAuthScheme()
public
getAuthScheme() : string
Return values
string —getClientApiKey()
public
getClientApiKey() : string
Return values
string —getClientKey()
public
getClientKey() : string
Return values
string —getClientSignatureKey()
public
getClientSignatureKey() : string
Return values
string —getDebug()
Gets the debug flag
public
getDebug() : bool
Return values
bool —getDebugFile()
Gets the debug file
public
getDebugFile() : string
Return values
string —getDefaultConfiguration()
Gets the default configuration instance
public
static getDefaultConfiguration() : Configuration
Return values
Configuration —getHost()
Gets the host
public
getHost() : string
Return values
string —Host
getPassword()
Gets the password for HTTP basic authentication
public
getPassword() : string
Return values
string —Password for HTTP basic authentication
getTempFolderPath()
Gets the temp folder path
public
getTempFolderPath() : string
Return values
string —Temp folder path
getUserAgent()
Gets the user agent of the api client
public
getUserAgent() : string
Return values
string —user agent
getUsername()
Gets the username for HTTP basic authentication
public
getUsername() : string
Return values
string —Username for HTTP basic authentication
setAccessToken()
Sets the access token for OAuth
public
setAccessToken(string $accessToken) : $this
Parameters
- $accessToken : string
-
Token for OAuth
Return values
$this —setApiKey()
Sets API key
public
setApiKey(string $apiKeyIdentifier, string $key) : $this
Parameters
- $apiKeyIdentifier : string
-
API key identifier (authentication scheme)
- $key : string
-
API key or token
Return values
$this —setApiKeyPrefix()
Sets the prefix for API key (e.g. Bearer)
public
setApiKeyPrefix(string $apiKeyIdentifier, string $prefix) : $this
Parameters
- $apiKeyIdentifier : string
-
API key identifier (authentication scheme)
- $prefix : string
-
API key prefix, e.g. Bearer
Return values
$this —setAuthScheme()
public
setAuthScheme(string $authScheme) : mixed
Parameters
- $authScheme : string
Return values
mixed —setClientApiKey()
public
setClientApiKey(string $clientApiKey) : mixed
Parameters
- $clientApiKey : string
Return values
mixed —setClientKey()
public
setClientKey(string $clientKey) : mixed
Parameters
- $clientKey : string
Return values
mixed —setClientSignatureKey()
public
setClientSignatureKey(string $clientSignatureKey) : mixed
Parameters
- $clientSignatureKey : string
Return values
mixed —setDebug()
Sets debug flag
public
setDebug(bool $debug) : $this
Parameters
- $debug : bool
-
Debug flag
Return values
$this —setDebugFile()
Sets the debug file
public
setDebugFile(string $debugFile) : $this
Parameters
- $debugFile : string
-
Debug file
Return values
$this —setDefaultConfiguration()
Sets the detault configuration instance
public
static setDefaultConfiguration(Configuration $config) : void
Parameters
- $config : Configuration
-
An instance of the Configuration Object
Return values
void —setHost()
Sets the host
public
setHost(string $host) : $this
Parameters
- $host : string
-
Host
Return values
$this —setPassword()
Sets the password for HTTP basic authentication
public
setPassword(string $password) : $this
Parameters
- $password : string
-
Password for HTTP basic authentication
Return values
$this —setTempFolderPath()
Sets the temp folder path
public
setTempFolderPath(string $tempFolderPath) : $this
Parameters
- $tempFolderPath : string
-
Temp folder path
Return values
$this —setUserAgent()
Sets the user agent of the api client
public
setUserAgent(string $userAgent) : $this
Parameters
- $userAgent : string
-
the user agent of the api client
Tags
Return values
$this —setUsername()
Sets the username for HTTP basic authentication
public
setUsername(string $username) : $this
Parameters
- $username : string
-
Username for HTTP basic authentication
Return values
$this —toDebugReport()
Gets the essential information for debugging
public
static toDebugReport() : string
Return values
string —The report for debugging