PHP Класс OAuth2Client

Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$access_token
$access_token_expires_at
$access_token_expires_in
$api_base_url
$authorize_url
$client_id
$client_secret
$curl_authenticate_method
$curl_compressed
$curl_connect_time_out
$curl_header
$curl_proxy
$curl_ssl_verifyhost
$curl_ssl_verifypeer
$curl_time_out
$curl_useragent
$http_code --
$http_info
$redirect_uri
$refresh_token
$sign_token_name --
$token_info_url
$token_url

Защищенные свойства (Protected)

Свойство Тип Описание
$response

Открытые методы

Метод Описание
__construct ( $client_id = false, $client_secret = false, $redirect_uri = '', $compressed = false ) --
api ( $url, $method = "GET", $parameters = [], $decode_json = true ) Format and sign an oauth for provider api
authenticate ( $code )
authenticated ( )
authorizeUrl ( $extras = [] )
delete ( $url, $parameters = [] ) DELETE wrapper for provider apis request
get ( $url, $parameters = [], $decode_json = true ) GET wrapper for provider apis request
getResponse ( ) : mixed Return the response object afer the fact
patch ( $url, $parameters = [] ) PATCH wrapper for provider apis request
post ( $url, $parameters = [], $decode_json = true ) POST wrapper for provider apis request
refreshToken ( $parameters = [] )
tokenInfo ( $accesstoken ) -- tokens

Приватные методы

Метод Описание
parseRequestResult ( $result )
request ( $url, $params = false, $type = "GET" ) -- utilities

Описание методов

__construct() публичный Метод

--
public __construct ( $client_id = false, $client_secret = false, $redirect_uri = '', $compressed = false )

api() публичный Метод

Format and sign an oauth for provider api
public api ( $url, $method = "GET", $parameters = [], $decode_json = true )

authenticate() публичный Метод

public authenticate ( $code )

authenticated() публичный Метод

public authenticated ( )

authorizeUrl() публичный Метод

public authorizeUrl ( $extras = [] )

delete() публичный Метод

DELETE wrapper for provider apis request
public delete ( $url, $parameters = [] )

get() публичный Метод

GET wrapper for provider apis request
public get ( $url, $parameters = [], $decode_json = true )

getResponse() публичный Метод

Return the response object afer the fact
public getResponse ( ) : mixed
Результат mixed

patch() публичный Метод

PATCH wrapper for provider apis request
public patch ( $url, $parameters = [] )

post() публичный Метод

POST wrapper for provider apis request
public post ( $url, $parameters = [], $decode_json = true )

refreshToken() публичный Метод

public refreshToken ( $parameters = [] )

tokenInfo() публичный Метод

-- tokens
public tokenInfo ( $accesstoken )

Описание свойств

$access_token публичное свойство

public $access_token

$access_token_expires_at публичное свойство

public $access_token_expires_at

$access_token_expires_in публичное свойство

public $access_token_expires_in

$api_base_url публичное свойство

public $api_base_url

$authorize_url публичное свойство

public $authorize_url

$client_id публичное свойство

public $client_id

$client_secret публичное свойство

public $client_secret

$curl_authenticate_method публичное свойство

public $curl_authenticate_method

$curl_compressed публичное свойство

public $curl_compressed

$curl_connect_time_out публичное свойство

public $curl_connect_time_out

$curl_header публичное свойство

public $curl_header

$curl_proxy публичное свойство

public $curl_proxy

$curl_ssl_verifyhost публичное свойство

public $curl_ssl_verifyhost

$curl_ssl_verifypeer публичное свойство

public $curl_ssl_verifypeer

$curl_time_out публичное свойство

public $curl_time_out

$curl_useragent публичное свойство

public $curl_useragent

$http_code публичное свойство

--
public $http_code

$http_info публичное свойство

public $http_info

$redirect_uri публичное свойство

public $redirect_uri

$refresh_token публичное свойство

public $refresh_token

$response защищенное свойство

protected $response

$sign_token_name публичное свойство

--
public $sign_token_name

$token_info_url публичное свойство

public $token_info_url

$token_url публичное свойство

public $token_url