0

Interface Yiisoft\Yii\AuthClient\OAuth2Interface

All Classes | Methods
ExtendsYiisoft\Yii\AuthClient\OAuthInterface
Implemented byYiisoft\Yii\AuthClient\Client\Discord, Yiisoft\Yii\AuthClient\Client\Facebook, Yiisoft\Yii\AuthClient\Client\GitHub, Yiisoft\Yii\AuthClient\Client\Google, Yiisoft\Yii\AuthClient\Client\LinkedIn, Yiisoft\Yii\AuthClient\Client\Microsoft, Yiisoft\Yii\AuthClient\Client\OpenIdConnect, Yiisoft\Yii\AuthClient\Client\TikTok, Yiisoft\Yii\AuthClient\Client\VKontakte, Yiisoft\Yii\AuthClient\Client\X, Yiisoft\Yii\AuthClient\Client\Yandex, Yiisoft\Yii\AuthClient\OAuth2

Interface for OAuth2 client functionality.

Public Methods

Hide inherited methods

Method Description Defined By
api() Performs request to the OAuth API returning response data. Yiisoft\Yii\AuthClient\OAuthInterface
applyAccessTokenToRequest() Applies access token to the HTTP request instance. Yiisoft\Yii\AuthClient\OAuthInterface
beforeApiRequestSend() Yiisoft\Yii\AuthClient\OAuthInterface
buildAuthUrl() Yiisoft\Yii\AuthClient\OAuth2Interface
createApiRequest() Creates an HTTP request for the API call. Yiisoft\Yii\AuthClient\OAuthInterface
fetchAccessToken() Yiisoft\Yii\AuthClient\OAuth2Interface
fetchAccessTokenWithCodeVerifier() Yiisoft\Yii\AuthClient\OAuth2Interface
getAccessToken() Yiisoft\Yii\AuthClient\OAuthInterface
getAuthParams() Yiisoft\Yii\AuthClient\OAuth2Interface
getClientId() Yiisoft\Yii\AuthClient\OAuth2Interface
getClientSecret() Yiisoft\Yii\AuthClient\OAuth2Interface
getCurrentUserJsonArray() Yiisoft\Yii\AuthClient\OAuth2Interface
getLogo() Yiisoft\Yii\AuthClient\OAuth2Interface
getName() Yiisoft\Yii\AuthClient\AuthClientInterface
getOauth2ReturnUrl() Yiisoft\Yii\AuthClient\OAuth2Interface
getReturnUrl() Yiisoft\Yii\AuthClient\OAuthInterface
getScope() Yiisoft\Yii\AuthClient\OAuthInterface
getSessionAuthState() Yiisoft\Yii\AuthClient\OAuth2Interface
getTitle() Yiisoft\Yii\AuthClient\AuthClientInterface
getTokenUrl() Yiisoft\Yii\AuthClient\OAuth2Interface
getUserAttributes() Yiisoft\Yii\AuthClient\AuthClientInterface
getViewOptions() Yiisoft\Yii\AuthClient\AuthClientInterface
getYiisoftFactory() Yiisoft\Yii\AuthClient\OAuthInterface
refreshAccessToken() Gets new auth token to replace expired one. Yiisoft\Yii\AuthClient\OAuthInterface
setAccessToken() Sets access token to be used. Yiisoft\Yii\AuthClient\OAuthInterface
setAuthParams() Yiisoft\Yii\AuthClient\OAuth2Interface
setAuthUrl() Yiisoft\Yii\AuthClient\OAuthInterface
setClientId() Yiisoft\Yii\AuthClient\OAuth2Interface
setClientSecret() Yiisoft\Yii\AuthClient\OAuth2Interface
setEnvironment() Yiisoft\Yii\AuthClient\OAuth2Interface
setLogo() Yiisoft\Yii\AuthClient\OAuth2Interface
setOauth2ReturnUrl() Yiisoft\Yii\AuthClient\OAuth2Interface
setYiisoftFactory() Yiisoft\Yii\AuthClient\OAuthInterface

Method Details

Hide inherited methods

api() public abstract method

Defined in: Yiisoft\Yii\AuthClient\OAuthInterface::api()

Performs request to the OAuth API returning response data.

public abstract array api ( string $apiSubUrl, string $method = 'GET', array|string $data = [], array $headers = [] )
$apiSubUrl string
$method string
$data array|string
$headers array 

                public function api(string $apiSubUrl, string $method = 'GET', array|string $data = [], array $headers = []): array;
applyAccessTokenToRequest() public abstract method

Defined in: Yiisoft\Yii\AuthClient\OAuthInterface::applyAccessTokenToRequest()

Applies access token to the HTTP request instance.

public abstract \Psr\Http\Message\RequestInterface applyAccessTokenToRequest ( \Psr\Http\Message\RequestInterface $request, Yiisoft\Yii\AuthClient\OAuthToken $accessToken )
$request \Psr\Http\Message\RequestInterface
$accessToken Yiisoft\Yii\AuthClient\OAuthToken 

                public function applyAccessTokenToRequest(
    RequestInterface $request,
    OAuthToken $accessToken,
): RequestInterface;
beforeApiRequestSend() public abstract method

Defined in: Yiisoft\Yii\AuthClient\OAuthInterface::beforeApiRequestSend()

public abstract \Psr\Http\Message\RequestInterface beforeApiRequestSend ( \Psr\Http\Message\RequestInterface $request )
$request \Psr\Http\Message\RequestInterface 

                public function beforeApiRequestSend(RequestInterface $request): RequestInterface;
buildAuthUrl() public abstract method

public abstract string buildAuthUrl ( \Psr\Http\Message\ServerRequestInterface $incomingRequest, array $params = [] )
$incomingRequest \Psr\Http\Message\ServerRequestInterface
$params array 

                public function buildAuthUrl(ServerRequestInterface $incomingRequest, array $params = []): string;
createApiRequest() public abstract method

Defined in: Yiisoft\Yii\AuthClient\OAuthInterface::createApiRequest()

Creates an HTTP request for the API call.

public abstract \Psr\Http\Message\RequestInterface createApiRequest ( string $method, string $uri )
$method string
$uri string 

                public function createApiRequest(string $method, string $uri): RequestInterface;
fetchAccessToken() public abstract method

public abstract Yiisoft\Yii\AuthClient\OAuthToken fetchAccessToken ( \Psr\Http\Message\ServerRequestInterface $incomingRequest, string $authCode, array $params = [] )
$incomingRequest \Psr\Http\Message\ServerRequestInterface
$authCode string
$params array 

                public function fetchAccessToken(
    ServerRequestInterface $incomingRequest,
    string $authCode,
    array $params = [],
): OAuthToken;
fetchAccessTokenWithCodeVerifier() public abstract method

public abstract Yiisoft\Yii\AuthClient\OAuthToken fetchAccessTokenWithCodeVerifier ( \Psr\Http\Message\ServerRequestInterface $incomingRequest, string $authCode, array $params = [] )
$incomingRequest \Psr\Http\Message\ServerRequestInterface
$authCode string
$params array 

                public function fetchAccessTokenWithCodeVerifier(
    ServerRequestInterface $incomingRequest,
    string $authCode,
    array $params = [],
): OAuthToken;
getAccessToken() public abstract method

Defined in: Yiisoft\Yii\AuthClient\OAuthInterface::getAccessToken()

public abstract Yiisoft\Yii\AuthClient\OAuthToken|null getAccessToken ( )

                public function getAccessToken(): ?OAuthToken;
getAuthParams() public abstract method

public abstract array getAuthParams ( )

                public function getAuthParams(): array;
getClientId() public abstract method

public abstract string getClientId ( )

                public function getClientId(): string;
getClientSecret() public abstract method

public abstract string getClientSecret ( )

                public function getClientSecret(): string;
getCurrentUserJsonArray() public abstract method

public abstract array getCurrentUserJsonArray ( Yiisoft\Yii\AuthClient\OAuthToken $oauthToken )
$oauthToken Yiisoft\Yii\AuthClient\OAuthToken 

                public function getCurrentUserJsonArray(OAuthToken $oauthToken): array;
getLogo() public abstract method

public abstract ?string getLogo ( )

getName() public abstract method

Defined in: Yiisoft\Yii\AuthClient\AuthClientInterface::getName()

public abstract string getName ( )
return string

Service name.

 

                public function getName(): string;
getOauth2ReturnUrl() public abstract method

public abstract string getOauth2ReturnUrl ( )

                public function getOauth2ReturnUrl(): string;
getReturnUrl() public abstract method

Defined in: Yiisoft\Yii\AuthClient\OAuthInterface::getReturnUrl()

public abstract string getReturnUrl ( \Psr\Http\Message\ServerRequestInterface $request )
$request \Psr\Http\Message\ServerRequestInterface 

                public function getReturnUrl(ServerRequestInterface $request): string;
getScope() public abstract method

Defined in: Yiisoft\Yii\AuthClient\OAuthInterface::getScope()

public abstract string getScope ( )

                public function getScope(): string;
getSessionAuthState() public abstract method

public abstract mixed getSessionAuthState ( )

                public function getSessionAuthState(): mixed;
getTitle() public abstract method

Defined in: Yiisoft\Yii\AuthClient\AuthClientInterface::getTitle()

public abstract string getTitle ( )
return string

Service title.

 

                public function getTitle(): string;
getTokenUrl() public abstract method

public abstract string getTokenUrl ( )

                public function getTokenUrl(): string;
getUserAttributes() public abstract method

Defined in: Yiisoft\Yii\AuthClient\AuthClientInterface::getUserAttributes()

public abstract array getUserAttributes ( )
return array

Authenticated user's attributes.

 

                public function getUserAttributes(): array;
getViewOptions() public abstract method

Defined in: Yiisoft\Yii\AuthClient\AuthClientInterface::getViewOptions()

public abstract array getViewOptions ( )
return array

View options in format: optionName => optionValue

 

                public function getViewOptions(): array;
getYiisoftFactory() public abstract method

Defined in: Yiisoft\Yii\AuthClient\OAuthInterface::getYiisoftFactory()

public abstract \Yiisoft\Factory\Factory getYiisoftFactory ( )

                public function getYiisoftFactory(): YiisoftFactory;
refreshAccessToken() public abstract method

Defined in: Yiisoft\Yii\AuthClient\OAuthInterface::refreshAccessToken()

Gets new auth token to replace expired one.

public abstract Yiisoft\Yii\AuthClient\OAuthToken refreshAccessToken ( Yiisoft\Yii\AuthClient\OAuthToken $token )
$token Yiisoft\Yii\AuthClient\OAuthToken 

                public function refreshAccessToken(OAuthToken $token): OAuthToken;
setAccessToken() public abstract method

Defined in: Yiisoft\Yii\AuthClient\OAuthInterface::setAccessToken()

Sets access token to be used.

public abstract void setAccessToken ( array|Yiisoft\Yii\AuthClient\OAuthToken $token )
$token array|Yiisoft\Yii\AuthClient\OAuthToken 

                public function setAccessToken(array|OAuthToken $token): void;
setAuthParams() public abstract method

public abstract void setAuthParams ( array $authParams )
$authParams array 

                public function setAuthParams(array $authParams): void;
setAuthUrl() public abstract method

Defined in: Yiisoft\Yii\AuthClient\OAuthInterface::setAuthUrl()

public abstract void setAuthUrl ( string $authUrl )
$authUrl string 

                public function setAuthUrl(string $authUrl): void;
setClientId() public abstract method

public abstract void setClientId ( string $clientId )
$clientId string 

                public function setClientId(string $clientId): void;
setClientSecret() public abstract method

public abstract void setClientSecret ( string $clientSecret )
$clientSecret string 

                public function setClientSecret(string $clientSecret): void;
setEnvironment() public abstract method

public abstract void setEnvironment ( string $devOrProd )
$devOrProd string 

                public function setEnvironment(string $devOrProd): void;
setLogo() public abstract method

public abstract void setLogo ( ?string $logo )
$logo ?string

setOauth2ReturnUrl() public abstract method

public abstract void setOauth2ReturnUrl ( string $returnUrl )
$returnUrl string 

                public function setOauth2ReturnUrl(string $returnUrl): void;
setYiisoftFactory() public abstract method

Defined in: Yiisoft\Yii\AuthClient\OAuthInterface::setYiisoftFactory()

public abstract void setYiisoftFactory ( \Yiisoft\Factory\Factory $factory )
$factory \Yiisoft\Factory\Factory 

                public function setYiisoftFactory(YiisoftFactory $factory): void;