oxdrp\Register_site クラス

oxdrp\Register_site の継承関係図

oxdrp\Register_site 連携図

公開メンバ関数
	__construct ()
	getRequestClientName ()
	setRequestClientName ($request_client_name)
	getRequestClientSecret ()
	setRequestClientSecret ($request_client_secret)
	getRequestClientId ()
	setRequestClientId ($request_client_id)
	getRequestOpHost ()
	setRequestOpHost ($request_op_host)
	getRequestClientLogoutUris ()
	setRequestClientLogoutUris ($request_client_logout_uris)
	getRequestResponseTypes ()
	setRequestResponseTypes ($request_response_types)
	getRequestGrantTypes ()
	setRequestGrantTypes ($request_grant_types)
	getRequestScope ()
	setRequestScope ($request_scope)
	getRequestPostLogoutRedirectUri ()
	setRequestPostLogoutRedirectUri ($request_post_logout_redirect_uri)
	getRequestClientJwksUri ()
	setRequestClientJwksUri ($request_client_jwks_uri)
	getRequestClientSectorIdentifierUri ()
	setRequestClientSectorIdentifierUri ($request_client_sector_identifier_uri)
	getRequestClientTokenEndpointAuthMethod ()
	setRequestClientTokenEndpointAuthMethod ($request_client_token_endpoint_auth_method)
	getRequestClientRequestUris ()
	setRequestClientRequestUris ($request_client_request_uris)
	getRequestApplicationType ()
	setRequestApplicationType ($request_application_type='web')
	getRequestAuthorizationRedirectUri ()
	setRequestAuthorizationRedirectUri ($request_authorization_redirect_uri)
	getRequestAcrValues ()
	setRequestAcrValues ($request_acr_values='basic')
	getRequestContacts ()
	setRequestContacts ($request_contacts)
	getResponseOxdId ()
	getResponseOpHost ()
	getRequestUiLocales ()
	setRequestUiLocales ($request_ui_locales)
	getRequestClaimsLocales ()
	setRequestClaimsLocales ($request_claims_locales)
	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_op_host = null
	$request_authorization_redirect_uri = null
	$request_client_id = null
	$request_client_name = null
	$request_client_secret = null
	$request_post_logout_redirect_uri = null
	$request_application_type = 'web'
	$request_acr_values = array()
	$request_client_jwks_uri = ''
	$request_client_token_endpoint_auth_method = ''
	$request_client_sector_identifier_uri = ''
	$request_client_request_uris = null
	$request_contacts = null
	$request_scope = array()
	$request_grant_types = array()
	$request_response_types = array()
	$request_client_logout_uris = null
	$request_ui_locales = null
	$request_claims_locales = null
	$response_oxd_id
	$response_op_host

詳解

構築子と解体子

__construct()

oxdrp\Register_site::__construct

(

)

Constructor

戻り値

void

            {
                parent::__construct(); // TODO: Change the autogenerated stub
                $this->setRequestApplicationType();
            }

関数詳解

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

getRequestAcrValues()

oxdrp\Register_site::getRequestAcrValues

(

)

戻り値

array

            {
                return $this->request_acr_values;
            }

getRequestApplicationType()

oxdrp\Register_site::getRequestApplicationType

(

)

戻り値

string

            {
                return $this->request_application_type;
            }

getRequestAuthorizationRedirectUri()

oxdrp\Register_site::getRequestAuthorizationRedirectUri

(

)

戻り値

string

            {
                return $this->request_authorization_redirect_uri;
            }

getRequestClaimsLocales()

oxdrp\Register_site::getRequestClaimsLocales

(

)

戻り値

array

            {
                return $this->request_claims_locales;
            }

getRequestClientId()

oxdrp\Register_site::getRequestClientId

(

)

戻り値

string

            {
                return $this->request_client_id;
            }

getRequestClientJwksUri()

oxdrp\Register_site::getRequestClientJwksUri

(

)

戻り値

string

            {
                return $this->request_client_jwks_uri;
            }

getRequestClientLogoutUris()

oxdrp\Register_site::getRequestClientLogoutUris

(

)

戻り値

array

            {
                return $this->request_client_logout_uris;
            }

getRequestClientName()

oxdrp\Register_site::getRequestClientName

(

)

戻り値

string

            {
                return $this->request_client_name;
            }

getRequestClientRequestUris()

oxdrp\Register_site::getRequestClientRequestUris

(

)

戻り値

array

            {
                return $this->request_client_request_uris;
            }

getRequestClientSecret()

oxdrp\Register_site::getRequestClientSecret

(

)

戻り値

string

            {
                return $this->request_client_secret;
            }

getRequestClientSectorIdentifierUri()

oxdrp\Register_site::getRequestClientSectorIdentifierUri

(

)

戻り値

array

            {
                return $this->request_client_sector_identifier_uri;
            }

getRequestClientTokenEndpointAuthMethod()

oxdrp\Register_site::getRequestClientTokenEndpointAuthMethod

(

)

戻り値

string

            {
                return $this->request_client_token_endpoint_auth_method;
            }

getRequestContacts()

oxdrp\Register_site::getRequestContacts

(

)

戻り値

array

            {
                return $this->request_contacts;
            }

getRequestGrantTypes()

oxdrp\Register_site::getRequestGrantTypes

(

)

戻り値

array

            {
                return $this->request_grant_types;
            }

getRequestOpHost()

oxdrp\Register_site::getRequestOpHost

(

)

戻り値

string

            {
                return $this->request_op_host;
            }

getRequestPostLogoutRedirectUri()

oxdrp\Register_site::getRequestPostLogoutRedirectUri

(

)

戻り値

string

            {
                return $this->request_post_logout_redirect_uri;
            }

getRequestResponseTypes()

oxdrp\Register_site::getRequestResponseTypes

(

)

戻り値

array

            {
                return $this->request_response_types;
            }

getRequestScope()

oxdrp\Register_site::getRequestScope

(

)

戻り値

array

            {
                return $this->request_scope;
            }

getRequestUiLocales()

oxdrp\Register_site::getRequestUiLocales

(

)

戻り値

array

            {
                return $this->request_ui_locales;
            }

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

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

getResponseOpHost()

oxdrp\Register_site::getResponseOpHost

(

)

戻り値

string

            {
                $this->response_op_host = $this->getResponseData()->op_host;
                return $this->response_op_host;
            }

getResponseOxdId()

oxdrp\Register_site::getResponseOxdId

(

)

戻り値

string

            {
                $this->response_oxd_id = $this->getResponseData()->oxd_id;
                return $this->response_oxd_id;
            }

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\Register_site::setCommand

(

)

Protocol command to oxd server

戻り値

void

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

setParams()

oxdrp\Register_site::setParams

(

)

Protocol parameter to oxd server

戻り値

void

            {
                $this->params = array(
                    "authorization_redirect_uri" => $this->getRequestAuthorizationRedirectUri(),
                    "op_host" => $this->getRequestOpHost(),
                    "post_logout_redirect_uri" => $this->getRequestPostLogoutRedirectUri(),
                    "application_type" => $this->getRequestApplicationType(),
                    "response_types"=> $this->getRequestResponseTypes(),
                    "grant_types" => $this->getRequestGrantTypes(),
                    "scope" => $this->getRequestScope(),
                    "acr_values" => $this->getRequestAcrValues(),
                    "client_name"=> $this->getRequestClientName(),
                    "client_jwks_uri" => $this->getRequestClientJwksUri(),
                    "client_token_endpoint_auth_method" => $this->getRequestClientTokenEndpointAuthMethod(),
                    "client_request_uris" => $this->getRequestClientRequestUris(),
                    "client_logout_uris"=> $this->getRequestClientLogoutUris(),
                    "client_sector_identifier_uri"=> $this->getRequestClientSectorIdentifierUri(),
                    "contacts" => $this->getRequestContacts(),
                    "ui_locales" => $this->getRequestUiLocales(),
                    "claims_locales" => $this->getRequestClaimsLocales(),
                    "client_id"=> $this->getRequestClientId(),
                    "client_secret"=> $this->getRequestClientSecret()
                );
            }

setRequestAcrValues()

oxdrp\Register_site::setRequestAcrValues

(

$request_acr_values = 'basic'

)

引数

array

$request_acr_values

戻り値

void

            {
                $this->request_acr_values = $request_acr_values;
            }

setRequestApplicationType()

oxdrp\Register_site::setRequestApplicationType

(

$request_application_type = 'web'

)

引数

string

$request_application_type

戻り値

void

            {
                $this->request_application_type = $request_application_type;
            }

setRequestAuthorizationRedirectUri()

oxdrp\Register_site::setRequestAuthorizationRedirectUri

(

$request_authorization_redirect_uri

)

引数

string

$request_authorization_redirect_uri

戻り値

void

            {
                $this->request_authorization_redirect_uri = $request_authorization_redirect_uri;
            }

setRequestClaimsLocales()

oxdrp\Register_site::setRequestClaimsLocales

(

$request_claims_locales

)

引数

array

$request_claims_locales

            {
                $this->request_claims_locales = $request_claims_locales;
            }

setRequestClientId()

oxdrp\Register_site::setRequestClientId

(

$request_client_id

)

引数

string

$request_client_id

            {
                $this->request_client_id = $request_client_id;
            }

setRequestClientJwksUri()

oxdrp\Register_site::setRequestClientJwksUri

(

$request_client_jwks_uri

)

引数

string

$request_client_jwks_uri

戻り値

void

            {
                $this->request_client_jwks_uri = $request_client_jwks_uri;
            }

setRequestClientLogoutUris()

oxdrp\Register_site::setRequestClientLogoutUris

(

$request_client_logout_uris

)

引数

array

$request_client_logout_uris

戻り値

void

            {
                $this->request_client_logout_uris = $request_client_logout_uris;
            }

setRequestClientName()

oxdrp\Register_site::setRequestClientName

(

$request_client_name

)

引数

string

$request_client_name

            {
                $this->request_client_name = $request_client_name;
            }

setRequestClientRequestUris()

oxdrp\Register_site::setRequestClientRequestUris

(

$request_client_request_uris

)

引数

array

$request_client_request_uris

戻り値

void

            {
                $this->request_client_request_uris = $request_client_request_uris;
            }

setRequestClientSecret()

oxdrp\Register_site::setRequestClientSecret

(

$request_client_secret

)

引数

string

$request_client_secret

            {
                $this->request_client_secret = $request_client_secret;
            }

setRequestClientSectorIdentifierUri()

oxdrp\Register_site::setRequestClientSectorIdentifierUri

(

$request_client_sector_identifier_uri

)

引数

array

$request_client_sector_identifier_uri

            {
                $this->request_client_sector_identifier_uri = $request_client_sector_identifier_uri;
            }

setRequestClientTokenEndpointAuthMethod()

oxdrp\Register_site::setRequestClientTokenEndpointAuthMethod

(

$request_client_token_endpoint_auth_method

)

引数

string

$request_client_token_endpoint_auth_method

戻り値

void

            {
                $this->request_client_token_endpoint_auth_method = $request_client_token_endpoint_auth_method;
            }

setRequestContacts()

oxdrp\Register_site::setRequestContacts

(

$request_contacts

)

引数

array

$request_contacts

戻り値

void

            {
                $this->request_contacts = $request_contacts;
            }

setRequestGrantTypes()

oxdrp\Register_site::setRequestGrantTypes

(

$request_grant_types

)

引数

array

$request_grant_types

戻り値

void

            {
                $this->request_grant_types = $request_grant_types;
            }

setRequestOpHost()

oxdrp\Register_site::setRequestOpHost

(

$request_op_host

)

引数

string

$request_op_host

戻り値

void

            {
                $this->request_op_host = $request_op_host;
            }

setRequestPostLogoutRedirectUri()

oxdrp\Register_site::setRequestPostLogoutRedirectUri

(

$request_post_logout_redirect_uri

)

引数

string

$request_post_logout_redirect_uri

戻り値

void

            {
                $this->request_post_logout_redirect_uri = $request_post_logout_redirect_uri;
            }

setRequestResponseTypes()

oxdrp\Register_site::setRequestResponseTypes

(

$request_response_types

)

引数

array

$request_response_types

戻り値

void

            {
                $this->request_response_types = $request_response_types;
            }

setRequestScope()

oxdrp\Register_site::setRequestScope

(

$request_scope

)

引数

array

$request_scope

戻り値

void

            {
                $this->request_scope = $request_scope;
            }

setRequestUiLocales()

oxdrp\Register_site::setRequestUiLocales

(

$request_ui_locales

)

引数

array

$request_ui_locales

            {
                $this->request_ui_locales = $request_ui_locales;
            }

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_acr_values

oxdrp\Register_site::$request_acr_values = array()

private

$request_application_type

oxdrp\Register_site::$request_application_type = 'web'

private

$request_authorization_redirect_uri

oxdrp\Register_site::$request_authorization_redirect_uri = null

private

$request_claims_locales

array Register_site::$request_claims_locales = null

private

$request_client_id

oxdrp\Register_site::$request_client_id = null

private

$request_client_jwks_uri

string Register_site::$request_client_jwks_uri = ''

private

$request_client_logout_uris

array Register_site::$request_client_logout_uris = null

private

$request_client_name

oxdrp\Register_site::$request_client_name = null

private

$request_client_request_uris

array Register_site::$request_client_request_uris = null

private

$request_client_secret

oxdrp\Register_site::$request_client_secret = null

private

$request_client_sector_identifier_uri

array Register_site::$request_client_sector_identifier_uri = ''

private

$request_client_token_endpoint_auth_method

string Register_site::$request_client_token_endpoint_auth_method = ''

private

$request_contacts

array Register_site::$request_contacts = null

private

$request_grant_types

oxdrp\Register_site::$request_grant_types = array()

private

$request_op_host

oxdrp\Register_site::$request_op_host = null

private

$request_post_logout_redirect_uri

oxdrp\Register_site::$request_post_logout_redirect_uri = null

private

$request_response_types

oxdrp\Register_site::$request_response_types = array()

private

$request_scope

oxdrp\Register_site::$request_scope = array()

private

$request_ui_locales

array Register_site::$request_ui_locales = null

private

$response_data

oxdrp\Client_OXD_RP::$response_data = array()

protectedinherited

$response_json

oxdrp\Client_OXD_RP::$response_json

protectedinherited

$response_object

oxdrp\Client_OXD_RP::$response_object

protectedinherited

$response_op_host

string Register_site::$response_op_host

private

Response parameter from oxd-server

$response_oxd_id

string Register_site::$response_oxd_id

private

Response parameter from oxd-server It is basic parameter for other protocols

$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/Register_site.php