0

Interface Yiisoft\Yii\AuthClient\OAuthInterface

All Classes | Methods
ExtendsYiisoft\Yii\AuthClient\AuthClientInterface
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\OAuth, Yiisoft\Yii\AuthClient\OAuth2, Yiisoft\Yii\AuthClient\OAuth2Interface

Interface for OAuth clients.

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\AuthClientInterface
createApiRequest() Creates an HTTP request for the API call. Yiisoft\Yii\AuthClient\OAuthInterface
getAccessToken() Yiisoft\Yii\AuthClient\OAuthInterface
getClientId() The Client id is publically visible in button urls The Client secret must not be made available publically => exclude from interface Yiisoft\Yii\AuthClient\AuthClientInterface
getName() Yiisoft\Yii\AuthClient\AuthClientInterface
getReturnUrl() Yiisoft\Yii\AuthClient\OAuthInterface
getScope() Yiisoft\Yii\AuthClient\OAuthInterface
getTitle() Yiisoft\Yii\AuthClient\AuthClientInterface
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
setAuthUrl() Yiisoft\Yii\AuthClient\OAuthInterface
setYiisoftFactory() Yiisoft\Yii\AuthClient\OAuthInterface

Method Details

Hide inherited methods

api() public abstract method

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

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

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

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

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

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;
getAccessToken() public abstract method

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

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

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

The Client id is publically visible in button urls The Client secret must not be made available publically => exclude from interface

public abstract string getClientId ( )

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

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

public abstract string getName ( )
return string

Service name.

 

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

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

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

public abstract string getScope ( )

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

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

public abstract string getTitle ( )
return string

Service title.

 

                public function getTitle(): 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

public abstract \Yiisoft\Factory\Factory getYiisoftFactory ( )

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

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

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;
setAuthUrl() public abstract method

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

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

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

                public function setYiisoftFactory(YiisoftFactory $factory): void;