Multimag  0.2.992
Поля данных
Класс oauth_client

Поля данных

 $error = ''
 Store the message that is returned when an error occurs. Подробнее...
 
 $debug = false
 Control whether debug output is enabled. Подробнее...
 
 $debug_http = false
 Control whether the dialog with the remote Web server should also be logged. Подробнее...
 
 $exit = false
 Determine if the current script should be exited. Подробнее...
 
 $debug_output = ''
 Capture the debug output generated by the class. Подробнее...
 
 $debug_prefix = 'OAuth client: '
 Mark the lines of the debug output to identify actions performed by this class. Подробнее...
 
 $server = ''
 Identify the type of OAuth server to access. Подробнее...
 
 $configuration_file = 'oauth_configuration.json'
 Specify the path of the configuration file that defines the properties of additional OAuth server types. Подробнее...
 
 $request_token_url = ''
 URL of the OAuth server to request the initial token for OAuth 1.0 and 1.0a servers. Подробнее...
 
 $dialog_url = ''
 URL of the OAuth server to redirect the browser so the user can grant access to your application. Подробнее...
 
 $pin_dialog_url = ''
 URL of the OAuth server to redirect the browser so the user can grant access to your application. Подробнее...
 
 $offline_dialog_url = ''
 
 $pin = ''
 Value of the pin code for pin based authorization. Подробнее...
 
 $append_state_to_redirect_uri = ''
 
 $access_token_url = ''
 OAuth server URL that will return the access token URL. Подробнее...
 
 $oauth_version = '2.0'
 Version of the protocol version supported by the OAuth server. Подробнее...
 
 $url_parameters = false
 Determine if the API call parameters should be moved to the call URL. Подробнее...
 
 $authorization_header = true
 Determine if the OAuth parameters should be passed via HTTP Authorization request header. Подробнее...
 
 $token_request_method = 'GET'
 Define the HTTP method that should be used to request tokens from the server. Подробнее...
 
 $signature_method = 'HMAC-SHA1'
 Define the method to generate the signature for API request parameters values. Подробнее...
 
 $redirect_uri = ''
 URL of the current script page that is calling this class. Подробнее...
 
 $client_id = ''
 Identifier of your application registered with the OAuth server. Подробнее...
 
 $client_secret = ''
 Secret value assigned to your application when it is registered with the OAuth server. Подробнее...
 
 $api_key = ''
 Identifier of your API key provided by the OAuth server. Подробнее...
 
 $get_token_with_api_key = false
 Option to determine if the access token should be retrieved using the API key value instead of the client secret. Подробнее...
 
 $scope = ''
 Permissions that your application needs to call the OAuth server APIs. Подробнее...
 
 $realm = ''
 Realm of authorization for OpenID Connect. Подробнее...
 
 $offline = false
 
 $access_token = ''
 Access token obtained from the OAuth server. Подробнее...
 
 $access_token_secret = ''
 Access token secret obtained from the OAuth server. Подробнее...
 
 $access_token_expiry = ''
 Timestamp of the expiry of the access token obtained from the OAuth server. Подробнее...
 
 $access_token_type = ''
 Type of access token obtained from the OAuth server. Подробнее...
 
 $default_access_token_type = ''
 Type of access token to be assumed when the OAuth server does not specify an access token type. Подробнее...
 
 $access_token_parameter = ''
 Name of the access token parameter to be passed in API call requests. Подробнее...
 
 $access_token_response
 The original response for the access token request. Подробнее...
 
 $store_access_token_response = false
 
 $access_token_authentication = ''
 
 $refresh_token = ''
 Refresh token obtained from the OAuth server. Подробнее...
 
 $access_token_error = ''
 
 $authorization_error = ''
 Error message returned when it was not possible to obtain an OAuth access token. Подробнее...
 
 $response_status = 0
 HTTP response status returned by the server when calling an API. Подробнее...
 
 $oauth_username = ''
 Define the user name to obtain authorization using a password. Подробнее...
 
 $oauth_password = ''
 Define the user name to obtain authorization using a password. Подробнее...
 
 $grant_type = "authorization_code"
 Define the type of grant to obtain the OAuth 2 access token. Подробнее...
 
 $http_arguments = array()
 Define additional arguments to configure the HTTP requests. Подробнее...
 
 $oauth_user_agent = 'PHP-OAuth-API (http://www.phpclasses.org/oauth-api $Revision: 1.138 $)'
 
 $response_time = 0
 
Function SetError($error)
Function SetPHPError($error,
&$php_error_message) Function
OutputDebug($message) Function
GetRequestTokenURL(&$request_token_url)
Function GetDialogURL(&$url,
$redirect_uri= '', $state=
'') Function GetAccessTokenURL(&$access_token_url)
Function GetStoredState(&$state)
Function GetRequestState(&$state)
Function GetRequestCode(&$code)
Function GetRequestError(&$error)
Function GetRequestDenied(&$denied)
Function GetRequestToken(&$token,
&$verifier) Function
GetRedirectURI(&$redirect_uri)
Function Redirect($url)
Function StoreAccessToken($access_token)
Function GetAccessToken(&$access_token)
Function ResetAccessToken()
Function Encode($value)
Function EncodeArray($array)
Function HMAC($, $data, $key)
Function 
Sign (&$url, $method, $parameters, $oauth, $request_content_type, $has_files, $post_values_in_uri, &$authorization, &$post_values)
 

Подробное описание

См. определение в файле oauth_client.php строка 11

Поля

$access_token = ''

Access token obtained from the OAuth server.

См. определение в файле oauth_client.php строка 73

$access_token_authentication = ''

Option to determine if the requests to obtain a new access token should use authentication to pass the application client ID and secret.

См. определение в файле oauth_client.php строка 91

$access_token_error = ''

См. определение в файле oauth_client.php строка 95

$access_token_expiry = ''

Timestamp of the expiry of the access token obtained from the OAuth server.

См. определение в файле oauth_client.php строка 77

$access_token_parameter = ''

Name of the access token parameter to be passed in API call requests.

См. определение в файле oauth_client.php строка 83

$access_token_response

The original response for the access token request.

См. определение в файле oauth_client.php строка 85

$access_token_secret = ''

Access token secret obtained from the OAuth server.

См. определение в файле oauth_client.php строка 75

$access_token_type = ''

Type of access token obtained from the OAuth server.

См. определение в файле oauth_client.php строка 79

$access_token_url = ''

OAuth server URL that will return the access token URL.

См. определение в файле oauth_client.php строка 44

$api_key = ''

Identifier of your API key provided by the OAuth server.

См. определение в файле oauth_client.php строка 62

$append_state_to_redirect_uri = ''

Pass the OAuth session state in a variable with a different name to work around implementation bugs of certain OAuth servers

См. определение в файле oauth_client.php строка 42

$authorization_error = ''

Error message returned when it was not possible to obtain an OAuth access token.

См. определение в файле oauth_client.php строка 97

$authorization_header = true

Determine if the OAuth parameters should be passed via HTTP Authorization request header.

См. определение в файле oauth_client.php строка 50

$client_id = ''

Identifier of your application registered with the OAuth server.

См. определение в файле oauth_client.php строка 58

$client_secret = ''

Secret value assigned to your application when it is registered with the OAuth server.

См. определение в файле oauth_client.php строка 60

$configuration_file = 'oauth_configuration.json'

Specify the path of the configuration file that defines the properties of additional OAuth server types.

См. определение в файле oauth_client.php строка 28

$debug = false

Control whether debug output is enabled.

См. определение в файле oauth_client.php строка 16

$debug_http = false

Control whether the dialog with the remote Web server should also be logged.

См. определение в файле oauth_client.php строка 18

$debug_output = ''

Capture the debug output generated by the class.

См. определение в файле oauth_client.php строка 22

$debug_prefix = 'OAuth client: '

Mark the lines of the debug output to identify actions performed by this class.

См. определение в файле oauth_client.php строка 24

$default_access_token_type = ''

Type of access token to be assumed when the OAuth server does not specify an access token type.

См. определение в файле oauth_client.php строка 81

$dialog_url = ''

URL of the OAuth server to redirect the browser so the user can grant access to your application.

См. определение в файле oauth_client.php строка 32

$error = ''

Store the message that is returned when an error occurs.

См. определение в файле oauth_client.php строка 14

$exit = false

Determine if the current script should be exited.

См. определение в файле oauth_client.php строка 20

$get_token_with_api_key = false

Option to determine if the access token should be retrieved using the API key value instead of the client secret.

См. определение в файле oauth_client.php строка 64

$grant_type = "authorization_code"

Define the type of grant to obtain the OAuth 2 access token.

См. определение в файле oauth_client.php строка 106

$http_arguments = array()

Define additional arguments to configure the HTTP requests.

См. определение в файле oauth_client.php строка 109

$oauth_password = ''

Define the user name to obtain authorization using a password.

См. определение в файле oauth_client.php строка 103

$oauth_user_agent = 'PHP-OAuth-API (http://www.phpclasses.org/oauth-api $Revision: 1.138 $)'

См. определение в файле oauth_client.php строка 110

$oauth_username = ''

Define the user name to obtain authorization using a password.

См. определение в файле oauth_client.php строка 101

$oauth_version = '2.0'

Version of the protocol version supported by the OAuth server.

См. определение в файле oauth_client.php строка 46

$offline = false

Specify whether it will be necessary to call the API when the user is not present and the server supports renewing expired access tokens using refresh tokens.

См. определение в файле oauth_client.php строка 71

$offline_dialog_url = ''

URL of the OAuth server to redirect the browser so the user can grant access to your application when offline access is requested.

См. определение в файле oauth_client.php строка 37

$pin = ''

Value of the pin code for pin based authorization.

См. определение в файле oauth_client.php строка 39

$pin_dialog_url = ''

URL of the OAuth server to redirect the browser so the user can grant access to your application.

См. определение в файле oauth_client.php строка 34

$realm = ''

Realm of authorization for OpenID Connect.

См. определение в файле oauth_client.php строка 68

$redirect_uri = ''

URL of the current script page that is calling this class.

См. определение в файле oauth_client.php строка 56

$refresh_token = ''

Refresh token obtained from the OAuth server.

См. определение в файле oauth_client.php строка 93

$request_token_url = ''

URL of the OAuth server to request the initial token for OAuth 1.0 and 1.0a servers.

См. определение в файле oauth_client.php строка 30

$response_status = 0

HTTP response status returned by the server when calling an API.

См. определение в файле oauth_client.php строка 99

$response_time = 0

См. определение в файле oauth_client.php строка 111

$scope = ''

Permissions that your application needs to call the OAuth server APIs.

См. определение в файле oauth_client.php строка 66

$server = ''

Identify the type of OAuth server to access.

См. определение в файле oauth_client.php строка 26

$signature_method = 'HMAC-SHA1'

Define the method to generate the signature for API request parameters values.

См. определение в файле oauth_client.php строка 54

$store_access_token_response = false

Option to determine if the original response for the access token request should be stored in the access_token_response variable.

См. определение в файле oauth_client.php строка 88

$token_request_method = 'GET'

Define the HTTP method that should be used to request tokens from the server.

См. определение в файле oauth_client.php строка 52

$url_parameters = false

Determine if the API call parameters should be moved to the call URL.

См. определение в файле oauth_client.php строка 48

Function SetError ($error) Function SetPHPError ($error, &$php_error_message) Function OutputDebug ($message) Function GetRequestTokenURL (&$request_token_url) Function GetDialogURL (&$url, $redirect_uri= '', $state= '') Function GetAccessTokenURL (&$access_token_url) Function GetStoredState (&$state) Function GetRequestState (&$state) Function GetRequestCode (&$code) Function GetRequestError (&$error) Function GetRequestDenied (&$denied) Function GetRequestToken (&$token, &$verifier) Function GetRedirectURI (&$redirect_uri) Function Redirect ($url) Function StoreAccessToken ($access_token) Function GetAccessToken (&$access_token) Function ResetAccessToken () Function Encode ($value) Function EncodeArray ($array) Function HMAC ($, $data, $key) Function Sign(&$url, $method, $parameters, $oauth, $request_content_type, $has_files, $post_values_in_uri, &$authorization, &$post_values)

См. определение в файле oauth_client.php строка 439


Объявления и описания членов класса находятся в файле: