Get_tokens_by_code クラス

Get_tokens_by_code の継承関係図

Get_tokens_by_code 連携図

公開メンバ関数
	__construct ()
	getRequestScopes ()
	setRequestScopes ($request_scopes)
	getRequestOxdId ()
	setRequestOxdId ($request_oxd_id)
	getRequestState ()
	setRequestState ($request_state)
	getRequestCode ()
	setRequestCode ($request_code)
	getResponseAccessToken ()
	getResponseExpiresIn ()
	getResponseIdToken ()
	getResponseIdTokenClaims ()
	setCommand ()
	setParams ()
	oxd_socket_request ($data, $char_count=8192)
	request ()
	getResponseData ()
	getData ()
	getCommand ()
	getResponseObject ()
	getResponseJSON ()
	getParams ()

限定公開変数類
	$data = array()
	$command
	$db
	$params = array()
	$response_json
	$response_object
	$response_data = array()

静的限定公開変数類
static	$socket = null

非公開変数類
	$request_oxd_id = null
	$request_code = null
	$request_state = null
	$request_scopes = null
	$response_access_token
	$response_expires_in
	$response_id_token
	$response_id_token_claims

詳解

構築子と解体子

__construct()

Get_tokens_by_code::__construct

(

)

Constructor

戻り値

void

    {
        parent::__construct(); // TODO: Change the autogenerated stub
    }

関数詳解

getCommand()

Client_OXD_RP::getCommand ( )

inherited

戻り値

string

    {
        return $this->command;
    }

getData()

Client_OXD_RP::getData ( )

inherited

戻り値

array

    {
        $this->data = array('command' => $this->getCommand(), 'params' => $this->getParams());
        return $this->data;
    }

getParams()

Client_OXD_RP::getParams ( )

inherited

戻り値

array

    {
        return $this->params;
    }

getRequestCode()

Get_tokens_by_code::getRequestCode

(

)

戻り値

string

    {
        return $this->request_code;
    }

getRequestOxdId()

Get_tokens_by_code::getRequestOxdId

(

)

戻り値

string

    {
        return $this->request_oxd_id;
    }

getRequestScopes()

Get_tokens_by_code::getRequestScopes

(

)

戻り値

string

    {
        return $this->request_scopes;
    }

getRequestState()

Get_tokens_by_code::getRequestState

(

)

戻り値

string

    {
        return $this->request_state;
    }

getResponseAccessToken()

Get_tokens_by_code::getResponseAccessToken

(

)

戻り値

string

    {
        $this->response_access_token = $this->getResponseData()->access_token;
        return $this->response_access_token;
    }

getResponseData()

Client_OXD_RP::getResponseData ( )

inherited

戻り値

mixed

    {
        if (!$this->getResponseObject()) {
            $this->response_data = 'Data is empty';
            return;
        } else {
            $this->response_data = $this->getResponseObject()->data;
        }
        return $this->response_data;
    }

getResponseExpiresIn()

Get_tokens_by_code::getResponseExpiresIn

(

)

戻り値

string

    {
        $this->response_expires_in = $this->getResponseData()->expires_in;
        return $this->response_expires_in;
    }

getResponseIdToken()

Get_tokens_by_code::getResponseIdToken

(

)

戻り値

string

    {
        $this->response_id_token = $this->getResponseData()->id_token;
        return $this->response_id_token;
    }

getResponseIdTokenClaims()

Get_tokens_by_code::getResponseIdTokenClaims

(

)

戻り値

string

    {
        $this->response_id_token_claims = $this->getResponseData()->id_token_claims;
        return $this->response_id_token_claims;
    }

getResponseJSON()

Client_OXD_RP::getResponseJSON ( )

inherited

function getting result from oxD server. return: response_json - The JSON response from the oxD Server

    {
        return $this->response_json;
    }

getResponseObject()

Client_OXD_RP::getResponseObject ( )

inherited

getResult function geting result from oxD server. Return: response_object - The JSON response parsing to object

    {
        return $this->response_object;
    }

oxd_socket_request()

Client_OXD_RP::oxd_socket_request (   $data,   $char_count = 8192  )

inherited

request to oxd socket

                                                                 {
        $db = new DB(DB_DRIVER, DB_HOSTNAME, DB_USERNAME, DB_PASSWORD, DB_DATABASE, DB_PORT);
        $oxd_config = json_decode($db->query("SELECT `gluu_value` FROM `" . DB_PREFIX ."gluu_table` WHERE `gluu_action` LIKE 'gluu_config'")->row['gluu_value'],true);
        self::$socket = stream_socket_client('127.0.0.1:' . $oxd_config['gluu_oxd_port'], $errno, $errstr, STREAM_CLIENT_PERSISTENT);
        if (!self::$socket) {
            return 'Can not connect to oxd server';
        }else{
            fwrite(self::$socket, $data);
            $result = fread(self::$socket, $char_count);
            fclose(self::$socket);
            return $result;
        }

    }

request()

Client_OXD_RP::request ( )

inherited

send function sends the command to the oxD server.

Args: command (dict) - Dict representation of the JSON command string

    {
        $this->setParams();

        $jsondata = json_encode($this->getData(), JSON_UNESCAPED_SLASHES);

        $lenght = strlen($jsondata);
        if($lenght<=0){
            return array('status'=> false, 'message'=> 'Sorry .Problem with oxd.');
        }else{
            $lenght = $lenght <= 999 ? "0" . $lenght : $lenght;
        }

        $this->response_json =  $this->oxd_socket_request(utf8_encode($lenght . $jsondata));
        if($this->response_json !='Can not connect to oxd server'){
            $this->response_json = str_replace(substr($this->response_json, 0, 4), "", $this->response_json);
            if ($this->response_json) {
                $object = json_decode($this->response_json);
                if ($object->status == 'error') {
                    if($object->data->error == "invalid_op_host"){
                        return array('status'=> false, 'message'=> $object->data->error);
                    }elseif($object->data->error == "internal_error"){
                        return array('status'=> false, 'message'=> $object->data->error , 'error_message'=>$object->data->error_description);
                    }else{
                        return array('status'=> false, 'message'=> $object->data->error . ' : ' . $object->data->error_description);
                    }
                } elseif ($object->status == 'ok') {
                    $this->response_object = json_decode($this->response_json);
                    return array('status'=> true);
                }
            }
        }else{
            return array('status'=> false, 'message'=> 'Can not connect to the oxd server. Please check the oxd-config.json file to make sure you have entered the correct port and the oxd server is operational.');
        }

    }

setCommand()

Get_tokens_by_code::setCommand

(

)

Protocol command to oXD server

戻り値

void

    {
        $this->command = 'get_tokens_by_code';
    }

setParams()

Get_tokens_by_code::setParams

(

)

Protocol parameter to oXD server

戻り値

void

    {
        $this->params = array(
            "oxd_id" => $this->getRequestOxdId(),
            "code" => $this->getRequestCode(),
            "state" => $this->getRequestState()
        );
    }

setRequestCode()

Get_tokens_by_code::setRequestCode

(

$request_code

)

引数

string

$request_code

戻り値

void

    {
        $this->request_code = $request_code;
    }

setRequestOxdId()

Get_tokens_by_code::setRequestOxdId

(

$request_oxd_id

)

引数

string

$request_oxd_id

戻り値

void

    {
        $this->request_oxd_id = $request_oxd_id;
    }

setRequestScopes()

Get_tokens_by_code::setRequestScopes

(

$request_scopes

)

引数

string

$request_scopes

戻り値

void

    {
        $this->request_scopes = $request_scopes;
    }

setRequestState()

Get_tokens_by_code::setRequestState

(

$request_state

)

引数

string

$request_state

戻り値

void

    {
        $this->request_state = $request_state;
    }

メンバ詳解

$command

Client_OXD_RP::$command

protectedinherited

$data

Client_OXD_RP::$data = array()

protectedinherited

$db

Client_OXD_RP::$db

protectedinherited

$params

Client_OXD_RP::$params = array()

protectedinherited

$request_code

Get_tokens_by_code::$request_code = null

private

$request_oxd_id

Get_tokens_by_code::$request_oxd_id = null

private

$request_scopes

Get_tokens_by_code::$request_scopes = null

private

$request_state

Get_tokens_by_code::$request_state = null

private

$response_access_token

string Get_tokens_by_code::$response_access_token

private

Response parameter from oXD-server It need to using for get_user_info and logout classes

$response_data

Client_OXD_RP::$response_data = array()

protectedinherited

$response_expires_in

string Get_tokens_by_code::$response_expires_in

private

Response parameter from oXD-server Showing user expires time

Response parameter from oXD-server Showing user claimses and data

$response_id_token

string Get_tokens_by_code::$response_id_token

private

Response parameter from oXD-server It need to using for get_user_info and logout classes

$response_id_token_claims

Get_tokens_by_code::$response_id_token_claims

private

$response_json

Client_OXD_RP::$response_json

protectedinherited

$response_object

Client_OXD_RP::$response_object

protectedinherited

$socket

Client_OXD_RP::$socket = null

staticprotectedinherited

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/OpenId/gluu/src/opencart-oxd-module/system/library/oxd-rp/Get_tokens_by_code.php