oxdrp\Get_tokens_by_code クラス

oxdrp\Get_tokens_by_code の継承関係図

oxdrp\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 ()
	request ()
	getResponseStatus ()
	setResponseStatus ()
	getResponseData ()
	getData ()
	getCommand ()
	getResponseObject ()
	getResponseJSON ()
	getParams ()
	is_JSON ($string)
	define_variables ($configOBJECT)
	oxd_socket_request ($data, $char_count=8192)
	error_message ($error)
	log ($process, $message)

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

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

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

詳解

構築子と解体子

__construct()

oxdrp\Get_tokens_by_code::__construct

(

)

Constructor

戻り値

void

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

関数詳解

define_variables()

oxdrp\Client_Socket_OXD_RP::define_variables (   $configOBJECT )

inherited

Defining oxd-setting.json file for static object Oxd_RP_config

戻り値

void

                                                           {
                Oxd_RP_config::$op_host = $configOBJECT->op_host;
                Oxd_RP_config::$oxd_host_port = $configOBJECT->oxd_host_port;
                Oxd_RP_config::$authorization_redirect_uri = $configOBJECT->authorization_redirect_uri;
                Oxd_RP_config::$post_logout_redirect_uri = $configOBJECT->post_logout_redirect_uri;
                Oxd_RP_config::$scope = $configOBJECT->scope;
                Oxd_RP_config::$application_type = $configOBJECT->application_type;
                Oxd_RP_config::$response_types = $configOBJECT->response_types;
                Oxd_RP_config::$grant_types = $configOBJECT->grant_types;
                Oxd_RP_config::$acr_values = $configOBJECT->acr_values;
        
            }

error_message()

oxdrp\Client_Socket_OXD_RP::error_message (   $error )

inherited

Showing errors and exit.

引数

string

$error

戻り値

void

            {
                die($error);
            }

getCommand()

oxdrp\Client_OXD_RP::getCommand ( )

inherited

Protocol name for request.

戻り値

string

            {
                return $this->command;
            }

getData()

oxdrp\Client_OXD_RP::getData ( )

inherited

Data which need to send oXD server.

戻り値

array

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

getParams()

oxdrp\Client_OXD_RP::getParams ( )

inherited

Parameters for request.

戻り値

array

            {
                return $this->params;
            }

getRequestCode()

oxdrp\Get_tokens_by_code::getRequestCode

(

)

戻り値

string

            {
                return $this->request_code;
            }

getRequestOxdId()

oxdrp\Get_tokens_by_code::getRequestOxdId

(

)

戻り値

string

            {
                return $this->request_oxd_id;
            }

getRequestScopes()

oxdrp\Get_tokens_by_code::getRequestScopes

(

)

戻り値

string

            {
                return $this->request_scopes;
            }

getRequestState()

oxdrp\Get_tokens_by_code::getRequestState

(

)

戻り値

string

            {
                return $this->request_state;
            }

getResponseAccessToken()

oxdrp\Get_tokens_by_code::getResponseAccessToken

(

)

戻り値

string

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

getResponseData()

oxdrp\Client_OXD_RP::getResponseData ( )

inherited

If data is not empty it is returning response data from oxd-server in format array. If data empty or error , you have problem with parameter or protocol.

戻り値

array

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

getResponseExpiresIn()

oxdrp\Get_tokens_by_code::getResponseExpiresIn

(

)

戻り値

string

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

getResponseIdToken()

oxdrp\Get_tokens_by_code::getResponseIdToken

(

)

戻り値

string

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

getResponseIdTokenClaims()

oxdrp\Get_tokens_by_code::getResponseIdTokenClaims

(

)

戻り値

string

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

getResponseJSON()

oxdrp\Client_OXD_RP::getResponseJSON ( )

inherited

If response data is not empty it is returning response data from oxd-server in format json. If response data empty or error , you have problem with parameter or protocol.

戻り値

string

            {
                return $this->response_json;
            }

getResponseObject()

oxdrp\Client_OXD_RP::getResponseObject ( )

inherited

If response data is not empty it is returning response data from oxd-server in format object. If response data empty or error , you have problem with parameter or protocol.

戻り値

object

            {
                return $this->response_object;
            }

getResponseStatus()

oxdrp\Client_OXD_RP::getResponseStatus ( )

inherited

Response status

戻り値

string, OK on success, error on failure

            {
                return $this->response_status;
            }

is_JSON()

oxdrp\Client_OXD_RP::is_JSON (   $string )

inherited

Checking format string.

引数

string

$string

戻り値

bool

                                            {
                return is_string($string) && is_object(json_decode($string)) ? true : false;
            }

log()

oxdrp\Client_Socket_OXD_RP::log (   $process,   $message  )

inherited

Saving process in log file.

引数

string	$process
string	$message

戻り値

void

                                                   {
                $OldFile  = $this->base_url.'/logs/oxd-php-server-'.date("Y-m-d") .'.log';
                $person = "\n".date('l jS \of F Y h:i:s A')."\n".$process.$message."\n";
                file_put_contents($OldFile, $person, FILE_APPEND | LOCK_EX);
        
            }

oxd_socket_request()

oxdrp\Client_Socket_OXD_RP::oxd_socket_request (   $data,   $char_count = 8192  )

inherited

Sending request to oXD server via socket

引数

string	$data
int	$char_count

戻り値

object

                                                                        {
                if (!self::$socket = stream_socket_client( '127.0.0.1:' . Oxd_RP_config::$oxd_host_port, $errno, $errstr, STREAM_CLIENT_PERSISTENT)) {
                    $this->log("Client: socket::socket_connect is not connected, error: ",$errstr);
                    die($errno);
                }else{
                    $this->log("Client: socket::socket_connect", "socket connected");
                }
                $this->log("Client: oxd_socket_request", fwrite(self::$socket, $data));
                fwrite(self::$socket, $data);
                $result = fread(self::$socket, $char_count);
                if($result){
                    $this->log("Client: oxd_socket_response", $result);
                }else{
                    $this->log("Client: oxd_socket_response", 'Error socket reading process.');
                }
                if(fclose(self::$socket)){
                    $this->log("Client: oxd_socket_connection", "disconnected.");
                }
                return $result;
            }

request()

oxdrp\Client_OXD_RP::request ( )

inherited

send function sends the command to the oxD server.

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

戻り値

void

            {
                $this->setParams();
        
                $jsondata = json_encode($this->getData(), JSON_UNESCAPED_SLASHES);
        
                if(!$this->is_JSON($jsondata)){
                    $this->log("Sending parameters must be JSON.",'Exiting process.');
                    $this->error_message('Sending parameters must be JSON.');
                }
                $lenght = strlen($jsondata);
                if($lenght<=0){
                    $this->log("Length must be more than zero.",'Exiting process.');
                    $this->error_message("Length must be more than zero.");
                }else{
                    $lenght = $lenght <= 999 ? "0" . $lenght : $lenght;
                }
        
                $this->response_json = $this->oxd_socket_request(utf8_encode($lenght . $jsondata));
        
                $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') {
                        $this->error_message($object->data->error . ' : ' . $object->data->error_description);
                    } elseif ($object->status == 'ok') {
                        $this->response_object = json_decode($this->response_json);
                    }
                } else {
                    $this->log("Response is empty...",'Exiting process.');
                    $this->error_message('Response is empty...');
                }
            }

setCommand()

oxdrp\Get_tokens_by_code::setCommand

(

)

Protocol command to oxd server

戻り値

void

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

setParams()

oxdrp\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()

oxdrp\Get_tokens_by_code::setRequestCode

(

$request_code

)

引数

string

$request_code

戻り値

void

            {
                $this->request_code = $request_code;
            }

setRequestOxdId()

oxdrp\Get_tokens_by_code::setRequestOxdId

(

$request_oxd_id

)

引数

string

$request_oxd_id

戻り値

void

            {
                $this->request_oxd_id = $request_oxd_id;
            }

setRequestScopes()

oxdrp\Get_tokens_by_code::setRequestScopes

(

$request_scopes

)

引数

string

$request_scopes

戻り値

void

            {
                $this->request_scopes = $request_scopes;
            }

setRequestState()

oxdrp\Get_tokens_by_code::setRequestState

(

$request_state

)

引数

string

$request_state

戻り値

void

            {
                $this->request_state = $request_state;
            }

setResponseStatus()

oxdrp\Client_OXD_RP::setResponseStatus ( )

inherited

Setting response status

戻り値

void

            {
                $this->response_status = $this->getResponseObject()->status;
            }

メンバ詳解

$base_url

oxdrp\Client_Socket_OXD_RP::$base_url = __DIR__

protectedinherited

$command

oxdrp\Client_OXD_RP::$command

protectedinherited

$data

oxdrp\Client_OXD_RP::$data = array()

protectedinherited

$params

oxdrp\Client_OXD_RP::$params = array()

protectedinherited

$request_code

oxdrp\Get_tokens_by_code::$request_code = null

private

$request_oxd_id

oxdrp\Get_tokens_by_code::$request_oxd_id = null

private

$request_state

oxdrp\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

oxdrp\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

oxdrp\Get_tokens_by_code::$response_id_token_claims

private

$response_json

oxdrp\Client_OXD_RP::$response_json

protectedinherited

$response_object

oxdrp\Client_OXD_RP::$response_object

protectedinherited

$response_status

oxdrp\Client_OXD_RP::$response_status

protectedinherited

$socket

oxdrp\Client_Socket_OXD_RP::$socket = null

staticprotectedinherited

---

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

• D:/AppData/OpenId/gluu/src/oxd-php-api/src/oxdrp/Get_tokens_by_code.php