TGMDK_Config
in package
設定情報管理クラス
設定ファイルの読み取り、設定ファイルを使用する各クラスへのインターフェイスを提供する
Tags
Table of Contents
- ADD_URL_PAYMENT = "ADD_URL_PAYMENT"
- プロパティから取得するためのパラメータキー : 決済のURL付加情報
- ADD_URL_PAYMENT_VERSION = "ADD_URL_PAYMENT_VERSION"
- プロパティから取得するためのパラメータキー : 決済のバージョン
- ADD_URL_VTID = "ADD_URL_VTID"
- プロパティから取得するためのパラメータキー : VTIDのURL付加情報
- ADD_URL_VTID_VERSION = "ADD_URL_VTID_VERSION"
- プロパティから取得するためのパラメータキー : VTIDのバージョン
- BODY_ENCRYPT_MDK_ALIAS_NAME = "BODY_ENCRYPT_MDK_ALIAS_NAME"
- プロパティから取得するためのパラメータキー : クライアント鍵のエイリアス名
- BODY_ENCRYPT_SVR_ALIAS_NAME = "BODY_ENCRYPT_SVR_ALIAS_NAME"
- プロパティから取得するためのパラメータキー : サーバ鍵のエイリアス名
- CA_CERT_FILE = "CA_CERT_FILE"
- プロパティから取得するためのパラメータキー : SSL用サーバ公開鍵
- CIPHER_SECTION = "Cipher"
- プロパティから取得するためのセクション情報 - Cipher
- COMMON_ITEM = "COMMON_ITEM"
- プロパティから取得するためのパラメータキー : 共通項目
- CONNECTION_SECTION = "Connection"
- プロパティから取得するためのセクション情報 - Connection
- CONNECTION_TIMEOUT = "CONNECTION_TIMEOUT"
- プロパティから取得するためのパラメータキー : 接続タイムアウト時間
- DUMMY_REQUEST = "DUMMY_REQUEST"
- プロパティから取得するためのパラメータキー : ダミーリクエスト
- FGETS_FALSE_COMPLETE_COUNT = "FGETS_FALSE_COMPLETE_COUNT"
- プロパティから取得するためのパラメータキー : fgets完了の仮みなし回数
- HOST_URL = "HOST_URL"
- プロパティから取得するためのパラメータキー : GWのURL
- IGNORE_EOF = "IGNORE_EOF"
- プロパティから取得するためのパラメータキー : EOF判定無視フラグ
- MASK_ITEM = "MASK_ITEM"
- プロパティから取得するためのパラメータキー : マスク項目
- MDK_DTO_VERSION = "MDK_DTO_VERSION"
- プロパティから取得するためのパラメータキー : MDK DTO バージョン
- MDK_ERROR_MODE = "MDK_ERROR_MODE"
- プロパティから取得するためのパラメータキー : エラーモード
- MDK_VERSION = "MDK_VERSION"
- プロパティから取得するためのパラメータキー : MDKバージョン
- MERCHANT_CC_ID = "MERCHANT_CC_ID"
- プロパティから取得するためのパラメータキー : マーチャントCCID
- MERCHANT_SECRET_KEY = "MERCHANT_SECRET_KEY"
- プロパティから取得するためのパラメータキー : マーチャント認証鍵
- MESSAGE_DIGEST_TYPE = "MESSAGE_DIGEST_TYPE"
- プロパティから取得するためのパラメータキー : メッセージダイジェストのアルゴリズム
- PAYNOWID_SERVICE_TYPE = "PAYNOWID_SERVICE_TYPE"
- プロパティから取得するためのパラメータキー : VTIDのサービスタイプ
- PRIVATE_CERT_FILE = "PRIVATE_CERT_FILE"
- プロパティから取得するためのパラメータキー : エンドポイント暗号化のクライアント秘密鍵
- PRIVATE_CERT_PASSWORD = "PRIVATE_CERT_PASSWORD"
- プロパティから取得するためのパラメータキー : エンドポイント暗号化のクライアント秘密鍵のパスワード
- PRIVATE_CERT_PUBLIC_FILE = "PRIVATE_CERT_PUBLIC_FILE"
- プロパティから取得するためのパラメータキー : エンドポイント暗号化のクライアント公開鍵
- PROXY_PASSWORD = "PROXY_PASSWORD"
- プロパティから取得するためのパラメータキー : プロキシサーバ パスワード
- PROXY_PORT = "PROXY_PORT"
- プロパティから取得するためのパラメータキー : プロキシサーバポート
- PROXY_SERVER = "PROXY_SERVER"
- プロパティから取得するためのパラメータキー : プロキシサーバドメイン
- PROXY_SERVER_URL = "PROXY_SERVER_URL"
- プロパティから取得するためのパラメータキー : プロキシサーバURL
- PROXY_USERNAME = "PROXY_USERNAME"
- プロパティから取得するためのパラメータキー : プロキシサーバ ユーザ名
- READ_TIMEOUT = "READ_TIMEOUT"
- プロパティから取得するためのパラメータキー : 読み取りタイムアウト時間
- REQUEST_DTO_SECTION = "RequestDto"
- プロパティから取得するためのセクション情報 - RequestDto
- RESPONSE_DTO_SECTION = "ResponseDto"
- プロパティから取得するためのセクション情報 - ResponseDto
- SERVICE_SECTION = "Service"
- プロパティから取得するためのセクション情報 - Service
- TRUST_CERT_FILE = "TRUST_CERT_FILE"
- プロパティから取得するためのパラメータキー : エンドポイント暗号化のサーバ公開鍵
- URL_SECTION = "Url"
- プロパティから取得するためのセクション情報 - Url
- $conf_file_name : mixed
- 呼び出すプロパティファイルパスを格納する変数
- $instance : mixed
- 当クラスのインスタンスを保持する変数
- $m_config : mixed
- プロパティの情報を保持する変数
- $valids : mixed
- 例外を配列で保持する変数
- __getConfigFileName() : string
- インスタンス生成時のコンフィグファイル名取得(UNITテスト用)
- __reset() : mixed
- 静的なインスタンスを破棄する(UNITテスト用)
- getCipherParameters() : array<string|int, mixed>
- 電文暗号化に必要なパラメータを連想配列で返す
- getConnectionParameters() : array<string|int, mixed>
- 通信に必要なパラメータを連想配列で返す
- getErrors() : array<string|int, TGMDK_Exception>
- validate時に発生した例外を返却する
- getInstance() : TGMDK_Config
- TGMDK_Config クラスをインスタンス化する
- getRequestDtoParameters() : array<string|int, mixed>
- RequestDto に必要なパラメータを連想配列で返す
- getResponseDtoParameters() : array<string|int, mixed>
- ResponseDto に必要なパラメータを連想配列で返す
- getServiceParameters() : array<string|int, mixed>
- サービスに必要なパラメータを連想配列で返す
- getTransactionParameters() : array<string|int, mixed>
- メイン動作(Transaction)に必要なパラメータを連想配列で返す
- getUrlParameters() : array<string|int, mixed>
- Urlに必要なパラメータの連想配列を返す
- getUserAgent() : string
- 電文のヘッダ情報に載せるuser-agent情報の文字列を返す
- validate() : bool
- コンフィグファイルの各パラメータの検証を行う
- __construct() : mixed
- コンストラクタ。
- addError() : mixed
- Error原因を配列に保存する
- exist_of() : mixed
- getCipherSection() : mixed
- getConnectionSection() : mixed
- getRequestDtoSection() : mixed
- getResponseDtoSection() : mixed
- getServiceSection() : mixed
- getUrlSection() : mixed
- numeric_of() : mixed
- presence_of() : mixed
- resetErrors() : mixed
Constants
ADD_URL_PAYMENT
プロパティから取得するためのパラメータキー : 決済のURL付加情報
public
mixed
ADD_URL_PAYMENT
= "ADD_URL_PAYMENT"
ADD_URL_PAYMENT_VERSION
プロパティから取得するためのパラメータキー : 決済のバージョン
public
mixed
ADD_URL_PAYMENT_VERSION
= "ADD_URL_PAYMENT_VERSION"
ADD_URL_VTID
プロパティから取得するためのパラメータキー : VTIDのURL付加情報
public
mixed
ADD_URL_VTID
= "ADD_URL_VTID"
ADD_URL_VTID_VERSION
プロパティから取得するためのパラメータキー : VTIDのバージョン
public
mixed
ADD_URL_VTID_VERSION
= "ADD_URL_VTID_VERSION"
BODY_ENCRYPT_MDK_ALIAS_NAME
プロパティから取得するためのパラメータキー : クライアント鍵のエイリアス名
public
mixed
BODY_ENCRYPT_MDK_ALIAS_NAME
= "BODY_ENCRYPT_MDK_ALIAS_NAME"
BODY_ENCRYPT_SVR_ALIAS_NAME
プロパティから取得するためのパラメータキー : サーバ鍵のエイリアス名
public
mixed
BODY_ENCRYPT_SVR_ALIAS_NAME
= "BODY_ENCRYPT_SVR_ALIAS_NAME"
CA_CERT_FILE
プロパティから取得するためのパラメータキー : SSL用サーバ公開鍵
public
mixed
CA_CERT_FILE
= "CA_CERT_FILE"
CIPHER_SECTION
プロパティから取得するためのセクション情報 - Cipher
public
mixed
CIPHER_SECTION
= "Cipher"
COMMON_ITEM
プロパティから取得するためのパラメータキー : 共通項目
public
mixed
COMMON_ITEM
= "COMMON_ITEM"
CONNECTION_SECTION
プロパティから取得するためのセクション情報 - Connection
public
mixed
CONNECTION_SECTION
= "Connection"
CONNECTION_TIMEOUT
プロパティから取得するためのパラメータキー : 接続タイムアウト時間
public
mixed
CONNECTION_TIMEOUT
= "CONNECTION_TIMEOUT"
DUMMY_REQUEST
プロパティから取得するためのパラメータキー : ダミーリクエスト
public
mixed
DUMMY_REQUEST
= "DUMMY_REQUEST"
FGETS_FALSE_COMPLETE_COUNT
プロパティから取得するためのパラメータキー : fgets完了の仮みなし回数
public
mixed
FGETS_FALSE_COMPLETE_COUNT
= "FGETS_FALSE_COMPLETE_COUNT"
HOST_URL
プロパティから取得するためのパラメータキー : GWのURL
public
mixed
HOST_URL
= "HOST_URL"
IGNORE_EOF
プロパティから取得するためのパラメータキー : EOF判定無視フラグ
public
mixed
IGNORE_EOF
= "IGNORE_EOF"
MASK_ITEM
プロパティから取得するためのパラメータキー : マスク項目
public
mixed
MASK_ITEM
= "MASK_ITEM"
MDK_DTO_VERSION
プロパティから取得するためのパラメータキー : MDK DTO バージョン
public
mixed
MDK_DTO_VERSION
= "MDK_DTO_VERSION"
MDK_ERROR_MODE
プロパティから取得するためのパラメータキー : エラーモード
public
mixed
MDK_ERROR_MODE
= "MDK_ERROR_MODE"
MDK_VERSION
プロパティから取得するためのパラメータキー : MDKバージョン
public
mixed
MDK_VERSION
= "MDK_VERSION"
MERCHANT_CC_ID
プロパティから取得するためのパラメータキー : マーチャントCCID
public
mixed
MERCHANT_CC_ID
= "MERCHANT_CC_ID"
MERCHANT_SECRET_KEY
プロパティから取得するためのパラメータキー : マーチャント認証鍵
public
mixed
MERCHANT_SECRET_KEY
= "MERCHANT_SECRET_KEY"
MESSAGE_DIGEST_TYPE
プロパティから取得するためのパラメータキー : メッセージダイジェストのアルゴリズム
public
mixed
MESSAGE_DIGEST_TYPE
= "MESSAGE_DIGEST_TYPE"
PAYNOWID_SERVICE_TYPE
プロパティから取得するためのパラメータキー : VTIDのサービスタイプ
public
mixed
PAYNOWID_SERVICE_TYPE
= "PAYNOWID_SERVICE_TYPE"
PRIVATE_CERT_FILE
プロパティから取得するためのパラメータキー : エンドポイント暗号化のクライアント秘密鍵
public
mixed
PRIVATE_CERT_FILE
= "PRIVATE_CERT_FILE"
PRIVATE_CERT_PASSWORD
プロパティから取得するためのパラメータキー : エンドポイント暗号化のクライアント秘密鍵のパスワード
public
mixed
PRIVATE_CERT_PASSWORD
= "PRIVATE_CERT_PASSWORD"
PRIVATE_CERT_PUBLIC_FILE
プロパティから取得するためのパラメータキー : エンドポイント暗号化のクライアント公開鍵
public
mixed
PRIVATE_CERT_PUBLIC_FILE
= "PRIVATE_CERT_PUBLIC_FILE"
PROXY_PASSWORD
プロパティから取得するためのパラメータキー : プロキシサーバ パスワード
public
mixed
PROXY_PASSWORD
= "PROXY_PASSWORD"
PROXY_PORT
プロパティから取得するためのパラメータキー : プロキシサーバポート
public
mixed
PROXY_PORT
= "PROXY_PORT"
PROXY_SERVER
プロパティから取得するためのパラメータキー : プロキシサーバドメイン
public
mixed
PROXY_SERVER
= "PROXY_SERVER"
PROXY_SERVER_URL
プロパティから取得するためのパラメータキー : プロキシサーバURL
public
mixed
PROXY_SERVER_URL
= "PROXY_SERVER_URL"
PROXY_USERNAME
プロパティから取得するためのパラメータキー : プロキシサーバ ユーザ名
public
mixed
PROXY_USERNAME
= "PROXY_USERNAME"
READ_TIMEOUT
プロパティから取得するためのパラメータキー : 読み取りタイムアウト時間
public
mixed
READ_TIMEOUT
= "READ_TIMEOUT"
REQUEST_DTO_SECTION
プロパティから取得するためのセクション情報 - RequestDto
public
mixed
REQUEST_DTO_SECTION
= "RequestDto"
RESPONSE_DTO_SECTION
プロパティから取得するためのセクション情報 - ResponseDto
public
mixed
RESPONSE_DTO_SECTION
= "ResponseDto"
SERVICE_SECTION
プロパティから取得するためのセクション情報 - Service
public
mixed
SERVICE_SECTION
= "Service"
TRUST_CERT_FILE
プロパティから取得するためのパラメータキー : エンドポイント暗号化のサーバ公開鍵
public
mixed
TRUST_CERT_FILE
= "TRUST_CERT_FILE"
URL_SECTION
プロパティから取得するためのセクション情報 - Url
public
mixed
URL_SECTION
= "Url"
Properties
$conf_file_name
呼び出すプロパティファイルパスを格納する変数
private
mixed
$conf_file_name
$instance
当クラスのインスタンスを保持する変数
private
static mixed
$instance
= null
$m_config
プロパティの情報を保持する変数
private
static mixed
$m_config
= null
$valids
例外を配列で保持する変数
private
mixed
$valids
Methods
__getConfigFileName()
インスタンス生成時のコンフィグファイル名取得(UNITテスト用)
public
__getConfigFileName() : string
Return values
string —コンフィグファイル名
__reset()
静的なインスタンスを破棄する(UNITテスト用)
public
static __reset() : mixed
Return values
mixed —getCipherParameters()
電文暗号化に必要なパラメータを連想配列で返す
public
getCipherParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —パラメータ(連想配列)
getConnectionParameters()
通信に必要なパラメータを連想配列で返す
public
getConnectionParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —パラメータ(連想配列)
getErrors()
validate時に発生した例外を返却する
public
getErrors() : array<string|int, TGMDK_Exception>
Return values
array<string|int, TGMDK_Exception> —validate時に発生した例外の配列
getInstance()
TGMDK_Config クラスをインスタンス化する
public
static getInstance([string|null $configFileName = null ]) : TGMDK_Config
Parameters
- $configFileName : string|null = null
-
コンフィグファイル
Tags
Return values
TGMDK_Config —静的なコンフィグクラスのインスタンス
getRequestDtoParameters()
RequestDto に必要なパラメータを連想配列で返す
public
getRequestDtoParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —パラメータ(連想配列)
getResponseDtoParameters()
ResponseDto に必要なパラメータを連想配列で返す
public
getResponseDtoParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —パラメータ(連想配列)
getServiceParameters()
サービスに必要なパラメータを連想配列で返す
public
getServiceParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —パラメータ(連想配列)
getTransactionParameters()
メイン動作(Transaction)に必要なパラメータを連想配列で返す
public
getTransactionParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —パラメータ(連想配列)
getUrlParameters()
Urlに必要なパラメータの連想配列を返す
public
getUrlParameters() : array<string|int, mixed>
Return values
array<string|int, mixed> —パラメータ(連想配列)
getUserAgent()
電文のヘッダ情報に載せるuser-agent情報の文字列を返す
public
getUserAgent() : string
Return values
string —user-agent情報
validate()
コンフィグファイルの各パラメータの検証を行う
public
validate([bool $validOnly = FALSE ]) : bool
Parameters
- $validOnly : bool = FALSE
-
エラー発生時、TRUEは例外をスローしない、FALSEは例外をスローする
Return values
bool —パラメータの検証に成功: TRUE、それ以外: FALSE
__construct()
コンストラクタ。
private
__construct([string|null $configFileName = null ]) : mixed
Parameters
- $configFileName : string|null = null
-
読み込むコンフィグファイル名
Tags
Return values
mixed —addError()
Error原因を配列に保存する
private
addError(TGMDK_Exception $cause) : mixed
Parameters
- $cause : TGMDK_Exception
Return values
mixed —exist_of()
private
exist_of(mixed $section, mixed $key) : mixed
Parameters
- $section : mixed
- $key : mixed
Return values
mixed —getCipherSection()
private
getCipherSection() : mixed
Return values
mixed —getConnectionSection()
private
getConnectionSection([mixed $fillReadTimeout = FALSE ]) : mixed
Parameters
- $fillReadTimeout : mixed = FALSE
Return values
mixed —getRequestDtoSection()
private
getRequestDtoSection() : mixed
Return values
mixed —getResponseDtoSection()
private
getResponseDtoSection() : mixed
Return values
mixed —getServiceSection()
private
getServiceSection() : mixed
Return values
mixed —getUrlSection()
private
getUrlSection() : mixed
Return values
mixed —numeric_of()
private
numeric_of(mixed $section, mixed $key) : mixed
Parameters
- $section : mixed
- $key : mixed
Return values
mixed —presence_of()
private
presence_of(mixed $section, mixed $key) : mixed
Parameters
- $section : mixed
- $key : mixed
Return values
mixed —resetErrors()
private
resetErrors() : mixed