PHP Класс EOAuth2Service

Наследование: extends EAuthServiceBase, implements IAuthService
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$access_token current OAuth2 access token.
$client_id OAuth2 client id.
$client_secret OAuth2 client secret key.
$errorAccessDeniedCode Error code for access_denied response.
$errorDescriptionParam Error description key name in _GET options.
$errorParam Error key name in _GET options.
$providerOptions Provider options. Must contain the keys: authorize, access_token.
$scope OAuth scopes.

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

Метод Описание
authenticate ( ) : boolean Authenticate the user.
init ( $component, $options = [] )
makeSignedRequest ( string $url, array $options = [], boolean $parseJson = true ) : stdClass Returns the protected resource.

Защищенные методы

Метод Описание
getAccessToken ( string $code ) : string Returns the OAuth2 access token.
getCodeUrl ( string $redirect_uri ) : string Returns the url to request to get OAuth2 code.
getSignedRequestFields ( ) : array Returns fields required for signed request.
getTokenUrl ( string $code ) : string Returns the url to request to get OAuth2 access token.
restoreAccessToken ( ) : boolean Restore access token from the session.
saveAccessToken ( string $token ) Save access token to the session.

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

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

Authenticate the user.
public authenticate ( ) : boolean
Результат boolean whether user was successfuly authenticated.

getAccessToken() защищенный Метод

Returns the OAuth2 access token.
protected getAccessToken ( string $code ) : string
$code string the OAuth2 code. See {@link getCodeUrl}.
Результат string the token.

getCodeUrl() защищенный Метод

Returns the url to request to get OAuth2 code.
protected getCodeUrl ( string $redirect_uri ) : string
$redirect_uri string url to redirect after user confirmation.
Результат string url to request.

getSignedRequestFields() защищенный Метод

By default returns array('access_token' => $this->access_token). Used in {@link makeSignedRequest}.
protected getSignedRequestFields ( ) : array
Результат array

getTokenUrl() защищенный Метод

Returns the url to request to get OAuth2 access token.
protected getTokenUrl ( string $code ) : string
$code string
Результат string url to request.

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

public init ( $component, $options = [] )

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

Returns the protected resource.
См. также: makeRequest
public makeSignedRequest ( string $url, array $options = [], boolean $parseJson = true ) : stdClass
$url string url to request.
$options array HTTP request options. Keys: query, data, referer.
$parseJson boolean Whether to parse response in json format.
Результат stdClass the response.

restoreAccessToken() защищенный Метод

Restore access token from the session.
protected restoreAccessToken ( ) : boolean
Результат boolean whether the access token was successfuly restored.

saveAccessToken() защищенный Метод

Save access token to the session.
protected saveAccessToken ( string $token )
$token string access token.

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

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

current OAuth2 access token.
protected $access_token

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

OAuth2 client id.
protected $client_id

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

OAuth2 client secret key.
protected $client_secret

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

Error code for access_denied response.
protected $errorAccessDeniedCode

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

Error description key name in _GET options.
protected $errorDescriptionParam

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

Error key name in _GET options.
protected $errorParam

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

Provider options. Must contain the keys: authorize, access_token.
protected $providerOptions

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

OAuth scopes.
protected $scope