yiisoft/yii2-authclient API Documentation 2.1

This is the API Documentation for the yiisoft/yii2-authclient extension. Here you will find detailed information about all classes provided by this extension. Below you find a list of the existing classes, interfaces, and traits, ordered by their fully qualified name (including the namespace). Each of them has a dedicated page which contains a description about the purpose of the class, a list of the available methods, properties and constants, and detailed description on how to use each of them.

On this page you find all the classes included in version 2.1 of the extension. You can use the dropdown menu on the top right to switch between versions.

Class Description
yii\authclient\AuthAction AuthAction performs authentication via different auth clients.
yii\authclient\BaseClient BaseClient is a base Auth Client class.
yii\authclient\BaseOAuth BaseOAuth is a base class for the OAuth clients.
yii\authclient\ClientInterface ClientInterface declares basic interface all Auth clients should follow.
yii\authclient\Collection Collection is a storage for all auth clients in the application.
yii\authclient\InvalidResponseException InvalidResponseException represents an exception caused by invalid remote server response.
yii\authclient\OAuth1 OAuth1 serves as a client for the OAuth 1/1.0a flow.
yii\authclient\OAuth2 OAuth2 serves as a client for the OAuth 2 flow.
yii\authclient\OAuthToken Token represents OAuth token.
yii\authclient\OpenId OpenId provides a simple interface for OpenID (1.1 and 2.0) authentication.
yii\authclient\OpenIdConnect OpenIdConnect serves as a client for the OpenIdConnect flow.
yii\authclient\SessionStateStorage SessionStateStorage provides Auth client state storage based on web session.
yii\authclient\StateStorageInterface StateStorageInterface is an interface for Auth client state storage.
yii\authclient\clients\Facebook Facebook allows authentication via Facebook OAuth.
yii\authclient\clients\GitHub GitHub allows authentication via GitHub OAuth.
yii\authclient\clients\Google Google allows authentication via Google OAuth.
yii\authclient\clients\GoogleHybrid GoogleHybrid is an enhanced version of the yii\authclient\clients\Google, which uses Google+ hybrid sign-in flow, which relies on embedded JavaScript code to generate a sign-in button and handle user authentication dialog.
yii\authclient\clients\LinkedIn LinkedIn allows authentication via LinkedIn OAuth.
yii\authclient\clients\Live Live allows authentication via Microsoft Live OAuth.
yii\authclient\clients\Twitter Twitter allows authentication via Twitter OAuth.
yii\authclient\clients\TwitterOAuth2 TwitterOAuth2 allows authentication via Twitter OAuth 2.
yii\authclient\clients\VKontakte VKontakte allows authentication via VKontakte OAuth.
yii\authclient\clients\Yandex Yandex allows authentication via Yandex OAuth.
yii\authclient\signature\BaseMethod BaseMethod is a base class for the OAuth signature methods.
yii\authclient\signature\HmacSha HmacSha1 represents 'HMAC SHA' signature method.
yii\authclient\signature\PlainText PlainText represents 'PLAINTEXT' signature method.
yii\authclient\signature\RsaSha RsaSha1 represents 'SHAwithRSA' (also known as RSASSA-PKCS1-V1_5-SIGN with the SHA hash) signature method.
yii\authclient\widgets\AuthChoice AuthChoice prints buttons for authentication via various auth clients.
yii\authclient\widgets\AuthChoiceAsset AuthChoiceAsset is an asset bundle for yii\authclient\widgets\AuthChoice widget.
yii\authclient\widgets\AuthChoiceItem AuthChoiceItem is a base class for creating widgets, which can be used to render link for auth client at yii\authclient\widgets\AuthChoice.
yii\authclient\widgets\AuthChoiceStyleAsset AuthChoiceAsset is an asset bundle for yii\authclient\widgets\AuthChoice widget.
yii\authclient\widgets\GooglePlusButton GooglePlusButton renders Google+ sign-in button.