Overview
  • Namespace
  • Class

Namespaces

  • Mypos
    • IPC

Classes

  • Authorization
  • AuthorizationCapture
  • AuthorizationList
  • AuthorizationReverse
  • Base
  • Card
  • CardStore
  • Cart
  • Config
  • Customer
  • Defines
  • GetPaymentStatus
  • GetTxnStatus
  • Helper
  • IAPreAuthorization
  • IAPurchase
  • IAStoreCard
  • IAStoredCardUpdate
  • IPCGetTxnLog
  • Loader
  • MandateManagement
  • PreAuthorization
  • PreAuthorizationCancellation
  • PreAuthorizationCompletion
  • PreAuthorizationStatus
  • Purchase
  • PurchaseByIcard
  • Refund
  • RequestMoney
  • Response
  • Reversal

Exceptions

  • IPC_Exception

Class Config

IPC Configuration class

Namespace: Mypos\IPC
Located at Config.php

Methods summary

public
# __construct( )

Config constructor.

Config constructor.
public Mypos\IPC\Config
# setPrivateKeyPath( string $path )

Store private RSA key as a filepath

Store private RSA key as a filepath

Parameters

$path
File path

Returns

Mypos\IPC\Config

Throws

Mypos\IPC\IPC_Exception
public string
# getAPIPublicKey( )

IPC API public RSA key

IPC API public RSA key

Returns

string
public Mypos\IPC\Config
# setAPIPublicKey( string $publicKey )

IPC API public RSA key

IPC API public RSA key

Parameters

$publicKey

Returns

Mypos\IPC\Config
public Mypos\IPC\Config
# setAPIPublicKeyPath( string $path )

IPC API public RSA key as a filepath

IPC API public RSA key as a filepath

Parameters

$path

Returns

Mypos\IPC\Config

Throws

Mypos\IPC\IPC_Exception
public string
# getEncryptPublicKey( )

Public RSA key using for encryption sensitive data

Public RSA key using for encryption sensitive data

Returns

string
public Mypos\IPC\Config
# setEncryptPublicKey( string $key )

Public RSA key using for encryption sensitive data

Public RSA key using for encryption sensitive data

Parameters

$key

Returns

Mypos\IPC\Config
public Mypos\IPC\Config
# setEncryptPublicKeyPath( string $path )

Public RSA key using for encryption sensitive data

Public RSA key using for encryption sensitive data

Parameters

$path
File path

Returns

Mypos\IPC\Config

Throws

Mypos\IPC\IPC_Exception
public string
# getLang( )

Language code (ISO 639-1)

Language code (ISO 639-1)

Returns

string
public Mypos\IPC\Config
# setLang( string $lang )

Language code (ISO 639-1)

Language code (ISO 639-1)

Parameters

$lang

Returns

Mypos\IPC\Config
public string
# getDeveloperKey( )

Store private RSA key

Store private RSA key

Returns

string
public Mypos\IPC\Config
# setDeveloperKey( string $developerKey )

Set myPOS developer key.

Set myPOS developer key.

Parameters

$developerKey

Returns

Mypos\IPC\Config
public string
# getSource( )

Returns

string
public
# setSource( string $source )

Additional parameter to specify the source of request

Additional parameter to specify the source of request

Parameters

$source
public boolean
# validate( )

Validate all set config details

Validate all set config details

Returns

boolean

Throws

Mypos\IPC\IPC_Exception
public string
# getKeyIndex( )

Keyindex used for signing request

Keyindex used for signing request

Returns

string
public Mypos\IPC\Config
# setKeyIndex( integer $keyIndex )

Keyindex used for signing request

Keyindex used for signing request

Parameters

$keyIndex

Returns

Mypos\IPC\Config
public string
# getIpcURL( )

IPC API URL

IPC API URL

Returns

string
public Mypos\IPC\Config
# setIpcURL( string $ipc_url )

IPC API URL

IPC API URL

Parameters

$ipc_url

Returns

Mypos\IPC\Config
public integer
# getSid( )

Store ID

Store ID

Returns

integer
public Mypos\IPC\Config
# setSid( integer $sid )

Store ID

Store ID

Parameters

$sid

Returns

Mypos\IPC\Config
public string
# getWallet( )

Wallet number

Wallet number

Returns

string
public Mypos\IPC\Config
# setWallet( string $wallet )

Wallet number

Wallet number

Parameters

$wallet

Returns

Mypos\IPC\Config
public string
# getVersion( )

API Version

API Version

Returns

string
public Mypos\IPC\Config
# setVersion( string $version )

API Version

API Version

Parameters

$version

Returns

Mypos\IPC\Config
public string
# getPrivateKey( )

Store private RSA key

Store private RSA key

Returns

string
public Mypos\IPC\Config
# setPrivateKey( string $privateKey )

Store private RSA key

Store private RSA key

Parameters

$privateKey

Returns

Mypos\IPC\Config
public Mypos\IPC\Config
# loadConfigurationPackage( string $configurationPackage )

Decrypt data string and set configuration parameters

Decrypt data string and set configuration parameters

Parameters

$configurationPackage

Returns

Mypos\IPC\Config

Throws

Mypos\IPC\IPC_Exception
API documentation generated by ApiGen