oxdrp\Client_OXD_RP クラス

oxdrp\Client_OXD_RP の継承関係図

oxdrp\Client_OXD_RP 連携図

公開メンバ関数
	__construct ()
	request ()
	getResponseStatus ()
	setResponseStatus ()
	getResponseData ()
	getData ()
	getCommand ()
	setCommand ()
	getResponseObject ()
	getResponseJSON ()
	setParams ()
	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

非公開変数類
	$command_types

詳解

構築子と解体子

__construct()

oxdrp\Client_OXD_RP::__construct

(

)

Constructor

戻り値

void

            {
        
                parent::__construct(); // TODO: Change the autogenerated stub
                $this->setCommand();
                $exist = false;
                for ($i = 0; $i < count($this->command_types); $i++) {
        
                    if ($this->command_types[$i] == $this->getCommand()) {
                        $exist = true;
                        break;
                    }
                }
                if (!$exist) {
                    $this->log('Command: ' . $this->getCommand() . ' is not exist!','Exiting process.');
                    $this->error_message('Command: ' . $this->getCommand() . ' is not exist!');
                }
            }

関数詳解

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

(

)

Protocol name for request.

戻り値

string

            {
                return $this->command;
            }

getData()

oxdrp\Client_OXD_RP::getData

(

)

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

(

)

Parameters for request.

戻り値

array

            {
                return $this->params;
            }

getResponseData()

oxdrp\Client_OXD_RP::getResponseData

(

)

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;
            }

getResponseJSON()

oxdrp\Client_OXD_RP::getResponseJSON

(

)

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

(

)

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

(

)

Response status

戻り値

string, OK on success, error on failure

            {
                return $this->response_status;
            }

is_JSON()

oxdrp\Client_OXD_RP::is_JSON

(

$string

)

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

(

)

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\Client_OXD_RP::setCommand ( )

abstract

Setting protocol name for request.

戻り値

void

setParams()

oxdrp\Client_OXD_RP::setParams ( )

abstract

Setting parameters for request.

戻り値

void

setResponseStatus()

oxdrp\Client_OXD_RP::setResponseStatus

(

)

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

protected

$command_types

oxdrp\Client_OXD_RP::$command_types

private

初期値:

= array( 'get_authorization_url',
                                            'update_site_registration',
                                            'get_tokens_by_code',
                                            'get_user_info',
                                            'register_site',
                                            'get_logout_uri',
                                            'get_authorization_code',
                                            'uma_rs_protect',
                                            'uma_rs_check_access',
                                            'uma_rp_get_rpt',
                                            'uma_rp_authorize_rpt',
                                            'uma_rp_get_gat',
            )

$data

oxdrp\Client_OXD_RP::$data = array()

protected

$params

oxdrp\Client_OXD_RP::$params = array()

protected

$response_data

oxdrp\Client_OXD_RP::$response_data = array()

protected

$response_json

oxdrp\Client_OXD_RP::$response_json

protected

$response_object

oxdrp\Client_OXD_RP::$response_object

protected

$response_status

oxdrp\Client_OXD_RP::$response_status

protected

$socket

oxdrp\Client_Socket_OXD_RP::$socket = null

staticprotectedinherited

---

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

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