0 follower

Interface Yiisoft\Yii\AuthClient\AuthClientInterface

All Classes | Methods

Implemented by	Yiisoft\Yii\AuthClient\AuthClient, Yiisoft\Yii\AuthClient\Client\Facebook, Yiisoft\Yii\AuthClient\Client\GitHub, Yiisoft\Yii\AuthClient\Client\Google, Yiisoft\Yii\AuthClient\Client\LinkedIn, Yiisoft\Yii\AuthClient\Client\MicrosoftOnline, 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\OAuthInterface

Implemented by

ClientInterface declares basic interface all Auth clients should follow.

Public Methods

Method	Description	Defined By
buildAuthUrl()		Yiisoft\Yii\AuthClient\AuthClientInterface
getButtonClass()		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	Yiisoft\Yii\AuthClient\AuthClientInterface
getName()		Yiisoft\Yii\AuthClient\AuthClientInterface
getTitle()		Yiisoft\Yii\AuthClient\AuthClientInterface
getViewOptions()		Yiisoft\Yii\AuthClient\AuthClientInterface

buildAuthUrl() public abstract method

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

                public function buildAuthUrl(ServerRequestInterface $incomingRequest, array $params): string;

getButtonClass() public abstract method

public abstract getButtonClass( ): string

                public function getButtonClass(): string;

getClientId() public abstract method

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

public abstract getClientId( ): string

                public function getClientId(): string;

getName() public abstract method

public abstract getName( ): string
return	string	Service name.

                public function getName(): string;

getTitle() public abstract method

public abstract getTitle( ): string
return	string	Service title.

                public function getTitle(): string;

getViewOptions() public abstract method

public abstract getViewOptions( ): array
return	array	View options in format: optionName => optionValue

                public function getViewOptions(): array;