Класс YandexBase

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

Открытые члены
	getAuthUrl ()
	getInterface ()
	clearSitesSettings ()
	setAuthSettings ($settings=null)
	checkAuthExpired ()
	getAuth ($code)
	getCurrentUser ()
Открытые члены унаследованные от BitrixEngine
	__construct ()
	getProxy ()
	getAuthSettings ()
Открытые члены унаследованные от Engine
	getId ()
	getCode ()
	getSettings ()
	getClientId ()
	getClientSecret ()
	clearAuthSettings ()

Открытые атрибуты
const	QUERY_USER = 'https://login.yandex.ru/info'
Открытые атрибуты унаследованные от Engine
const	HTTP_STATUS_OK = 200
const	HTTP_STATUS_CREATED = 201
const	HTTP_STATUS_NO_CONTENT = 204
const	HTTP_STATUS_AUTHORIZATION = 401

Защищенные члены
	query ($scope, $method="GET", $data=null, $skipRefreshAuth=false)
	prepareQueryResult (array $result)
Защищенные члены унаследованные от Engine
	saveSettings ()

Защищенные данные
	$engineId = 'yandex_generic'
Защищенные данные унаследованные от BitrixEngine
	$engineId = 'bitrix_generic'
Защищенные данные унаследованные от Engine
	$engineId = 'unknown engine'
	$engine = null
	$engineSettings = array()
	$authInterface = null

Дополнительные унаследованные члены
Защищенные статические члены унаследованные от Engine
static	getEngine ($engineId)

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

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

Методы

checkAuthExpired()

checkAuthExpired

(

)

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

clearSitesSettings()

clearSitesSettings

(

)

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

getAuth()

getAuth

(

$code

)

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

getAuthUrl()

getAuthUrl

(

)

Returns URL to authorize app

Возвращает

string Url

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

getCurrentUser()

getCurrentUser

(

)

Returns current Yandex user data

Возвращает

array

Исключения

SystemException
YandexException

Переопределяется в YandexDirect.

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

getInterface()

getInterface

(

)

Creates OAuth interface object instance

Возвращает

\CYandexOAuthInterface

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

prepareQueryResult()

prepareQueryResult ( array $result )

protected

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

query()

query ( $scope, $method = "GET", $data = null, $skipRefreshAuth = false )

protected

Returns HttpClient object with query result

Аргументы

string	$scope	Url to call
string	$method	HTTP method (GET/POST/PUT supported)
array | null	$data	Post data
bool	$skipRefreshAuth	Skip authorization refresh

Возвращает

\Bitrix\Main\Web\HttpClient

Исключения

SystemException

Переопределяется в Yandex и YandexDirect.

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

setAuthSettings()

setAuthSettings

(

$settings = null

)

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

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

$engineId

$engineId = 'yandex_generic'

protected

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

QUERY_USER

const QUERY_USER = 'https://login.yandex.ru/info'

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