Skip to content

OAuth2

  • Full name: \OAuth2
  • This class is an Abstract class

Properties

access_token_lifetime

private $access_token_lifetime

auth_code_lifetime

private $auth_code_lifetime

refresh_token_lifetime

private $refresh_token_lifetime

Methods

auth_client_credentials

protected auth_client_credentials(mixed $client_id, mixed $client_secret = null): mixed
  • This method is abstract.

Parameters:

Parameter Type Description
$client_id mixed
$client_secret mixed

get_redirect_uri

protected get_redirect_uri(mixed $client_id): mixed
  • This method is abstract.

Parameters:

Parameter Type Description
$client_id mixed

get_access_token

protected get_access_token(mixed $token_id): mixed
  • This method is abstract.

Parameters:

Parameter Type Description
$token_id mixed

store_access_token

protected store_access_token(mixed $token_id, mixed $client_id, mixed $expires, mixed $scope = null): mixed
  • This method is abstract.

Parameters:

Parameter Type Description
$token_id mixed
$client_id mixed
$expires mixed
$scope mixed

get_supported_grant_types

protected get_supported_grant_types(): mixed

get_supported_auth_response_types

protected get_supported_auth_response_types(): mixed

get_supported_scopes

protected get_supported_scopes(): mixed

authorize_client_response_type

protected authorize_client_response_type(mixed $client_id, mixed $response_type): mixed

Parameters:

Parameter Type Description
$client_id mixed
$response_type mixed

authorize_client

protected authorize_client(mixed $client_id, mixed $grant_type): mixed

Parameters:

Parameter Type Description
$client_id mixed
$grant_type mixed

get_stored_auth_code

protected get_stored_auth_code(mixed $code): mixed

Parameters:

Parameter Type Description
$code mixed

store_auth_code

protected store_auth_code(mixed $code, mixed $client_id, mixed $redirect_uri, mixed $expires, mixed $scope): mixed

Parameters:

Parameter Type Description
$code mixed
$client_id mixed
$redirect_uri mixed
$expires mixed
$scope mixed

check_user_credentials

protected check_user_credentials(mixed $client_id, mixed $username, mixed $password): mixed

Parameters:

Parameter Type Description
$client_id mixed
$username mixed
$password mixed

check_assertion

protected check_assertion(mixed $client_id, mixed $assertion_type, mixed $assertion): mixed

Parameters:

Parameter Type Description
$client_id mixed
$assertion_type mixed
$assertion mixed

get_refresh_token

protected get_refresh_token(mixed $refresh_token): mixed

Parameters:

Parameter Type Description
$refresh_token mixed

store_refresh_token

protected store_refresh_token(mixed $token, mixed $client_id, mixed $expires, mixed $scope = null): mixed

Parameters:

Parameter Type Description
$token mixed
$client_id mixed
$expires mixed
$scope mixed

check_none_access

protected check_none_access(mixed $client_id): mixed

Parameters:

Parameter Type Description
$client_id mixed

get_default_authentication_realm

protected get_default_authentication_realm(): mixed

__construct

public __construct(mixed $access_token_lifetime = 3600, mixed $auth_code_lifetime = 30, mixed $refresh_token_lifetime = 1209600): mixed

Parameters:

Parameter Type Description
$access_token_lifetime mixed
$auth_code_lifetime mixed
$refresh_token_lifetime mixed

verify_access_token

public verify_access_token(mixed $scope = null, mixed $exit_not_present = true, mixed $exit_invalid = true, mixed $exit_expired = true, mixed $exit_scope = true, mixed $realm = null): mixed

Parameters:

Parameter Type Description
$scope mixed
$exit_not_present mixed
$exit_invalid mixed
$exit_expired mixed
$exit_scope mixed
$realm mixed

check_scope

private check_scope(mixed $required_scope, mixed $available_scope): mixed

Parameters:

Parameter Type Description
$required_scope mixed
$available_scope mixed

send_401_unauthorized

private send_401_unauthorized(mixed $realm, mixed $scope, mixed $error = null): mixed

Parameters:

Parameter Type Description
$realm mixed
$scope mixed
$error mixed

get_access_token_param

private get_access_token_param(): mixed

grant_access_token

public grant_access_token(): mixed

get_client_credentials

private get_client_credentials(): mixed

get_authorize_params

public get_authorize_params(): mixed

finish_client_authorization

public finish_client_authorization(mixed $is_authorized, mixed $type, mixed $client_id, mixed $redirect_uri, mixed $state, mixed $scope = null): mixed

Parameters:

Parameter Type Description
$is_authorized mixed
$type mixed
$client_id mixed
$redirect_uri mixed
$state mixed
$scope mixed

do_redirect_uri_callback

private do_redirect_uri_callback(mixed $redirect_uri, mixed $result): mixed

Parameters:

Parameter Type Description
$redirect_uri mixed
$result mixed

build_uri

private build_uri(mixed $uri, mixed $data): mixed

Parameters:

Parameter Type Description
$uri mixed
$data mixed

create_access_token

private create_access_token(mixed $client_id, mixed $scope): mixed

Parameters:

Parameter Type Description
$client_id mixed
$scope mixed

create_auth_code

private create_auth_code(mixed $client_id, mixed $redirect_uri, mixed $scope): mixed

Parameters:

Parameter Type Description
$client_id mixed
$redirect_uri mixed
$scope mixed

gen_access_token

private gen_access_token(): mixed

gen_auth_code

private gen_auth_code(): mixed

get_authorization_header

private get_authorization_header(): mixed

send_json_headers

private send_json_headers(): mixed

error

public error(mixed $code, mixed $message = null): mixed

Parameters:

Parameter Type Description
$code mixed
$message mixed

callback_error

public callback_error(mixed $redirect_uri, mixed $error, mixed $state, mixed $message = null, mixed $error_uri = null): mixed

Parameters:

Parameter Type Description
$redirect_uri mixed
$error mixed
$state mixed
$message mixed
$error_uri mixed

Automatically generated on 2025-03-18