1. class
  2. Eccube
  3. Framework
  4. Api
  5. Operation

Operation

class Operation

APIの実行処理本体 権限チェックと設定チェックを行い、APIオペレーション本体を呼び出す。 結果データの生成

Constants

API_DEBUG_MODE

APIDEBUGMODE
API_AUTH_TYPE_REFERER

認証タイプ
API_AUTH_TYPE_SESSION_TOKEN

API_AUTH_TYPE_API_SIGNATURE

API_AUTH_TYPE_CUSTOMER

API_AUTH_TYPE_MEMBER

API_AUTH_TYPE_CUSTOMER_LOGIN_SESSION

API_AUTH_TYPE_MEMBER_LOGIN_SESSION

API_AUTH_TYPE_IP

API_AUTH_TYPE_HOST

API_AUTH_TYPE_SSL

API_AUTH_TYPE_OPEN

Methods

boolean
checkMemberAccount(string $member_id, string $member_password)

有効な管理者ID/PASSかどうかチェックする

boolean
checkCustomerAccount(string $login_email, string $login_password)

会員ログインチェックを実行する.

boolean
checkReferer()

リファラーチェックを実行する.

boolean
checkApiSignature($operation_name, $arrParam, $arrApiConfig)

HMAC-SHA 署名認証チェック Refer: http://www.soumu.go.jp/mainsosiki/johotsusin/top/ninshou-law/law-index.html

boolean
checkIp(string $operation_name)

IPチェックを実行する.

string
getApiSecretKey(string $access_key)

ApiAccessKeyに対応した秘密鍵を取得する。

boolean
checkOperationAuth($operation_name, $arrParam, $arrApiConfig)

オペレーションの実行権限をチェックする

void
setApiBaseParam($objFormParam)

APIのリクエスト基本パラメーターの設定

array(string
doApiAction(array $arrPost)

API実行

array
getOperationRequestEcho(array $arrParam, float $start_time)

APIのリクエストのエコー情報の作成

sendApiResponse($type, $response_outer_name, $arrResponse)

No description

array
checkParam(FormParam $objFormParam)

APIのリクエスト基本パラメーターのチェック

Details

at line 58
protected boolean checkMemberAccount(string $member_id, string $member_password)

有効な管理者ID/PASSかどうかチェックする

Parameters

string $member_id ログインID文字列
string $member_password ログインパスワード文字列

Return Value

boolean ログイン情報が有効な場合 true

at line 84
protected boolean checkCustomerAccount(string $login_email, string $login_password)

会員ログインチェックを実行する.

Parameters

string $login_email ログインメールアドレス
string $login_password ログインパスワード

Return Value

boolean ログインに成功した場合 true; 失敗した場合 false

at line 100
protected boolean checkReferer()

リファラーチェックを実行する.

Return Value

boolean チェックに成功した場合 true; 失敗した場合 false

at line 123
protected boolean checkApiSignature($operation_name, $arrParam, $arrApiConfig)

HMAC-SHA 署名認証チェック Refer: http://www.soumu.go.jp/mainsosiki/johotsusin/top/ninshou-law/law-index.html

Parameters

$operation_name
$arrParam
$arrApiConfig

Return Value

boolean 署名認証に成功した場合 true; 失敗した場合 false

at line 178
protected boolean checkIp(string $operation_name)

IPチェックを実行する.

Parameters

string $operation_name 実行処理名

Return Value

boolean チェックに成功した場合 true; 失敗した場合 false

at line 198
protected string getApiSecretKey(string $access_key)

ApiAccessKeyに対応した秘密鍵を取得する。

Parameters

string $access_key

Return Value

string 秘密鍵文字列

at line 213
protected boolean checkOperationAuth($operation_name, $arrParam, $arrApiConfig)

オペレーションの実行権限をチェックする

Parameters

$operation_name
$arrParam
$arrApiConfig

Return Value

boolean 権限がある場合 true; 無い場合 false

at line 280
protected void setApiBaseParam($objFormParam)

APIのリクエスト基本パラメーターの設定

Parameters

$objFormParam

Return Value

void

at line 295
array(string doApiAction(array $arrPost)

API実行

Parameters

array $arrPost リクエストパラメーター

Return Value

array(string レスポンス名, array レスポンス配列)

at line 396
protected array getOperationRequestEcho(array $arrParam, float $start_time)

APIのリクエストのエコー情報の作成

Parameters

array $arrParam リクエストパラメーター
float $start_time 実行時間計測用開始時間

Return Value

array エコー情報配列 (XML用の _attributes 指定入り）

at line 418
sendApiResponse($type, $response_outer_name, $arrResponse)

Parameters

$type
$response_outer_name
$arrResponse

at line 440
protected array checkParam(FormParam $objFormParam)

APIのリクエスト基本パラメーターのチェック

Parameters

FormParam $objFormParam

Return Value

array $arrErr