Абстрактный класс yii\authclient\BaseOAuth

public yii\authclient\OAuthToken getAccessToken ( )
public void setAccessToken ( $token )

public string $apiBaseUrl = null

public string $authUrl = null

public boolean $autoRefreshAccessToken = true

public string getReturnUrl ( )
public void setReturnUrl ( $returnUrl )

public string $scope = null

public yii\authclient\signature\BaseMethod getSignatureMethod ( )
public void setSignatureMethod ( $signatureMethod )

public string $version = '1.0'

api() public method

Выполняет запрос к API OAuth, возвращая данные ответа.

Вместо этого можно использовать метод createApiRequest(), получая больший контроль над выполнением запроса.

См. также createApiRequest().

public array api ( $apiSubUrl, $method = 'GET', $data = [], $headers = [] )
$apiSubUrl	string	API под-URL, который будет добавлен к $apiBaseUrl, или абсолютный URL API.
$method	string	Метод запроса.
$data	array|string	Данные или содержимое запроса.
$headers	array	Дополнительные заголовки запроса.
return	array	Данные ответа API.

applyAccessTokenToRequest() public abstract method (available since version 2.1)

Применяет токен доступа к экземпляру HTTP-запроса.

public abstract void applyAccessTokenToRequest ( $request, $accessToken )
$request	yii\httpclient\Request	Экземпляр HTTP-запроса.
$accessToken	yii\authclient\OAuthToken	Экземпляр токена доступа.

beforeApiRequestSend() public method (available since version 2.1)

Обрабатывает событие yii\httpclient\Request::EVENT_BEFORE_SEND.

Применяет $accessToken к запросу.

public void beforeApiRequestSend ( $event )
$event	yii\httpclient\RequestEvent	Экземпляр события.
throws	yii\base\Exception	при неверном токене доступа.

composeUrl() protected method

Формирует URL из базового URL и параметров GET.

protected string composeUrl ( $url, array $params = [] )
$url	string	Базовый URL.
$params	array	Параметры GET.
return	string	Сформированный URL.

createApiRequest() public method (available since version 2.1)

Создает HTTP-запрос для вызова API.

Созданный запрос будет автоматически обработан, добавив параметры токена доступа и подпись перед отправкой. Можно использовать createRequest(), чтобы получить полный контроль над составлением и выполнением запроса.

См. также createRequest().

public yii\httpclient\Request createApiRequest ( )
return	yii\httpclient\Request	Экземпляр HTTP-запроса.

createHttpClient() protected method

Создает экземпляр HTTP-клиента из ссылки или конфигурации.

protected yii\httpclient\Client createHttpClient ( $reference )
$reference	string|array	Имя компонента или конфигурация в виде массива.
return	yii\httpclient\Client	Экземпляр HTTP-клиента.

createSignatureMethod() protected method

Создает экземпляр метода подписи из его конфигурации.

protected yii\authclient\signature\BaseMethod createSignatureMethod ( array $signatureMethodConfig )
$signatureMethodConfig	array	Конфигурация метода подписи.
return	yii\authclient\signature\BaseMethod	Экземпляр метода подписи.

createToken() protected method

Создает токен из его конфигурации.

protected yii\authclient\OAuthToken createToken ( array $tokenConfig = [] )
$tokenConfig	array	Конфигурация токена.
return	yii\authclient\OAuthToken	Экземпляр токена.

defaultRequestOptions() protected method

Возвращает параметры HTTP-запроса по умолчанию.

protected array defaultRequestOptions ( )
return	array	Параметры HTTP-запроса.

defaultReturnUrl() protected method

Формирует значение $returnUrl по умолчанию.

protected string defaultReturnUrl ( )
return	string	URL возврата.

getAccessToken() public method

public yii\authclient\OAuthToken getAccessToken ( )
return	yii\authclient\OAuthToken	Экземпляр токена авторизации.

getReturnUrl() public method

public string getReturnUrl ( )
return	string	URL возврата.

getSignatureMethod() public method

public yii\authclient\signature\BaseMethod getSignatureMethod ( )
return	yii\authclient\signature\BaseMethod	Экземпляр метода подписи.

refreshAccessToken() public abstract method

Получает новый токен авторизации для замены истекшего.

public abstract yii\authclient\OAuthToken refreshAccessToken ( yii\authclient\OAuthToken $token )
$token	yii\authclient\OAuthToken	Истекший токен авторизации.
return	yii\authclient\OAuthToken	Новый токен авторизации.

restoreAccessToken() protected method

Восстанавливает токен доступа.

protected yii\authclient\OAuthToken restoreAccessToken ( )
return	yii\authclient\OAuthToken	Токен авторизации.

saveAccessToken() protected method

Сохраняет токен как постоянное состояние.

protected $this сохранитьТокен ( $token )
$token	yii\authclient\OAuthToken|null	Токен авторизации для сохранения.
return	$this	Сам объект.

sendRequest() защищённый метод (доступен с версии 2.1)

Отправляет заданный HTTP-запрос, возвращая данные ответа.

protected массив sendRequest ( $request )
$request	yii\httpclient\Request	Отправляемый HTTP-запрос.
return	массив	Данные ответа.
throws	yii\authclient\InvalidResponseException	при некорректном ответе удалённого ресурса.

setAccessToken() публичный метод

Устанавливает токен доступа для использования.

public void установитьТокенДоступа ( $token )
$token	массив|yii\authclient\OAuthToken	Токен доступа или его конфигурация.

setHttpClient() публичный метод

Устанавливает HTTP-клиент для использования.

public void установитьHttpClient ( $httpClient )
$httpClient	массив|yii\httpclient\Client	Внутренний HTTP-клиент.

setReturnUrl() публичный метод

public void установитьUrlВозврата ( $returnUrl )
$returnUrl	строка	URL возврата

setSignatureMethod() публичный метод

Установить метод подписи, который будет использоваться.

public void установитьМетодПодписи ( $signatureMethod )
$signatureMethod	массив|yii\authclient\signature\BaseMethod	Экземпляр метода подписи или его конфигурация в виде массива.
throws	yii\base\InvalidParamException	при неправильном аргументе.