Класс OAuth

Граф наследования:OAuth:

Открытые члены
	buildMeta ()
	getOAuthEntity ()
	getStoredUid ()
	getRedirect (bool $final=true)
	getUrl ()
	getStoredToken ($uid=null, int $expireGapSeconds=10)
	getAccessToken ($code=null)
	getUserData ($secure=true)
	saveResponse ($state)
	getPublicUserData ()
	handleResponse (array $state, $context=self::WEB_TYPE)

Открытые статические члены
static	getKnownServices ()
static	getInstance ($service=null)
static	getInstanceByMeta ($meta)
static	parseMeta ($meta)
static	getTokenByMeta ($meta, int $expireGapSeconds=10)
static	getUserDataByMeta ($meta, $secure=true)
static	getServiceName ()

Открытые атрибуты
const	WEB_TYPE = 'web'
const	MOBILE_TYPE = 'mobile'

Защищенные члены
	fetchStoredToken ()
	mapUserData (array $userData)
	setPublicUserData (UserData $userData)

Защищенные данные
	$oauthEntity
	$service
	$storedUid
UserData	$publicUserData

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

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

Методы

buildMeta()

buildMeta

(

)

Returns packed metadata for instance

Возвращает

string

Исключения

Main

ObjectException

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

fetchStoredToken()

fetchStoredToken ( )

protected

Fetches token by instance UID from DB

Возвращает

array|false

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

getAccessToken()

getAccessToken

(

$code = null

)

Obtains tokens from service

Аргументы

string

$code

Service authorization code.

Возвращает

boolean

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

getInstance()

static getInstance ( $service = null )

static

Returns helper instance

Аргументы

string

$service

Service name.

Возвращает

\Bitrix\Mail\Helper\OAuth|false

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

getInstanceByMeta()

static getInstanceByMeta ( $meta )

static

Returns helper instance by packed metadata

Аргументы

string

$meta

Packed metadata.

Возвращает

\Bitrix\Mail\Helper\OAuth|false

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

getKnownServices()

static getKnownServices ( )

static

Returns the list of supported services

Возвращает

array

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

getOAuthEntity()

getOAuthEntity

(

)

Returns service interface entity

Возвращает

mixed

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

getPublicUserData()

getPublicUserData

(

)

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

getRedirect()

getRedirect

(

bool

$final = true

)

Returns server OAuth handler URI

Аргументы

boolean

$final

Skip Bitrix24 proxy.

Возвращает

string

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

getServiceName()

static getServiceName ( )

static

Returns service name

Исключения

Bitrix\Main\ObjectException

Возвращает

string

Переопределяется в Google, LiveId, Mailru, Office365 и Yandex.

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

getStoredToken()

getStoredToken	(		$uid = null,
		int	$expireGapSeconds = 10 )

Returns token by instance UID

Аргументы

string	$uid	Instance UID.
int	$expireGapSeconds	Gap needed for using token, to ensure when we use token it still alive

Возвращает

string|null

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

getStoredUid()

getStoredUid

(

)

Returns instance UID

Возвращает

string

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

getTokenByMeta()

static getTokenByMeta ( $meta, int $expireGapSeconds = 10 )

static

Returns token by packed metadata

Аргументы

string	$meta	Packed metadata.
int	$expireGapSeconds	Gap needed for using token, to ensure when we use token it still alive

Возвращает

string|null

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

getUrl()

getUrl

(

)

Returns service OAuth endpoint URI

Возвращает

string

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

getUserData()

getUserData

(

$secure = true

)

Returns user data

Аргументы

boolean

$secure

Strip raw data (includes tokens).

Возвращает

array|null

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

getUserDataByMeta()

static getUserDataByMeta ( $meta, $secure = true )

static

Returns user data by packed metadata

Аргументы

string	$meta	Packed metadata.
boolean	$secure	Strip raw data (includes tokens).

Возвращает

array|null

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

handleResponse()

handleResponse	(	array	$state,
			$context = self::WEB_TYPE )

Handles service response

Аргументы

array

$state

Response data.

Возвращает

void

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

mapUserData()

mapUserData ( array $userData )

abstractprotected

Returns unified user data

Аргументы

array

$userData

User data.

Возвращает

array

Переопределяется в Google, LiveId, Mailru, Office365 и Yandex.

parseMeta()

static parseMeta ( $meta )

static

Returns unpacked metadata

Аргументы

string

$meta

Packed metadata.

Возвращает

array

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

saveResponse()

saveResponse

(

$state

)

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

setPublicUserData()

setPublicUserData ( UserData $userData )

protected

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

Данные класса

$oauthEntity

$oauthEntity

protected

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

$publicUserData

UserData $publicUserData

protected

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

$service

$service

protected

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

$storedUid

$storedUid

protected

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

MOBILE_TYPE

const MOBILE_TYPE = 'mobile'

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

WEB_TYPE

const WEB_TYPE = 'web'

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