0 follower

Yii Framework 3.0 API Documentation

This is the Yii Framework API Documentation. Here you will find detailed information about all classes provided by the Framework. 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 3.0 of the framework. You can use the dropdown menu on the top right to switch between versions.

You can search API documentation using the search form on the top. You can search for class names and also method and property names, e.g. ActiveRecord.save() or just .save() or ::save().

This page is also available in JSON format:
curl https://www.yiiframework.com/doc/api/3.0/yii-auth-client -H 'Accept: application/json'

Class	Description
Yiisoft\Yii\AuthClient\Asset\AuthChoiceAsset	AuthChoiceAsset is an asset bundle for {@see AuthChoice} widget.
Yiisoft\Yii\AuthClient\Asset\AuthChoiceStyleAsset	AuthChoiceAsset is an asset bundle for {@see AuthChoice} widget.
Yiisoft\Yii\AuthClient\AuthAction	AuthAction performs authentication via different auth clients.
Yiisoft\Yii\AuthClient\AuthClient	AuthClient is a base Auth Client class.
Yiisoft\Yii\AuthClient\AuthClientInterface	ClientInterface declares basic interface all Auth clients should follow.
Yiisoft\Yii\AuthClient\Client\Facebook	Facebook allows authentication via Facebook OAuth.
Yiisoft\Yii\AuthClient\Client\GitHub	GitHub allows authentication via GitHub OAuth.
Yiisoft\Yii\AuthClient\Client\Google	Google allows authentication via Google OAuth2 using HTTP client. Here we are NOT using the alternative Client Libraries namely @see https://developers.google.com/people/v1/libraries#php In order to use Google OAuth2 you must create a project at https://console.cloud.google.com/cloud-resource-manager and setup its credentials at https://console.cloud.google.com/apis/credentials?project=[yourProjectId].
Yiisoft\Yii\AuthClient\Client\LinkedIn	LinkedIn allows authentication via LinkedIn OAuth.
Yiisoft\Yii\AuthClient\Client\MicrosoftOnline	Tested 09/01/2025
Yiisoft\Yii\AuthClient\Client\OpenIdConnect	OpenIdConnect serves as a client for the OpenIdConnect flow.
Yiisoft\Yii\AuthClient\Client\TikTok
Yiisoft\Yii\AuthClient\Client\VKontakte	VKontakte allows authentication via VKontakte OAuth 2.0
Yiisoft\Yii\AuthClient\Client\X	Date: 10/01/2025 X allows authentication via OAuth2.0 Authorization Code Flow with PKCE.
Yiisoft\Yii\AuthClient\Client\Yandex	Yandex allows authentication via Yandex OAuth.
Yiisoft\Yii\AuthClient\Collection	Collection is a storage for all auth clients in the application.
Yiisoft\Yii\AuthClient\Exception\ClientException
Yiisoft\Yii\AuthClient\Exception\InvalidConfigException
Yiisoft\Yii\AuthClient\Exception\InvalidResponseException	InvalidResponseException represents an exception caused by invalid remote server response.
Yiisoft\Yii\AuthClient\Exception\NotSupportedException
Yiisoft\Yii\AuthClient\Factory\CollectionFactory
Yiisoft\Yii\AuthClient\OAuth	BaseOAuth is a base class for the OAuth clients.
Yiisoft\Yii\AuthClient\OAuth2	OAuth2 serves as a client for the OAuth 2 flow.
Yiisoft\Yii\AuthClient\OAuth2Interface	Interface for OAuth2 client functionality.
Yiisoft\Yii\AuthClient\OAuthInterface	Interface for OAuth clients.
Yiisoft\Yii\AuthClient\OAuthToken	Token represents OAuth token.
Yiisoft\Yii\AuthClient\RequestUtil
Yiisoft\Yii\AuthClient\Signature\HmacSha	HmacSha represents 'HMAC SHA' signature method.
Yiisoft\Yii\AuthClient\Signature\PlainText	PlainText represents 'PLAINTEXT' signature method.
Yiisoft\Yii\AuthClient\Signature\RsaSha	RsaSha1 represents 'SHAwithRSA' (also known as RSASSA-PKCS1-V1_5-SIGN with the SHA hash) signature method.
Yiisoft\Yii\AuthClient\Signature\Signature	BaseMethod is a base class for the OAuth signature methods.
Yiisoft\Yii\AuthClient\StateStorage\DummyStateStorage
Yiisoft\Yii\AuthClient\StateStorage\SessionStateStorage	SessionStateStorage provides Auth client state storage based on web session.
Yiisoft\Yii\AuthClient\StateStorage\StateStorageInterface	StateStorageInterface is an interface for Auth client state storage.
Yiisoft\Yii\AuthClient\Widget\AuthChoice	AuthChoice prints buttons for authentication via various auth clients.
Yiisoft\Yii\AuthClient\Widget\AuthChoiceItem	AuthChoiceItem is a base class for creating widgets, which can be used to render link for auth client at {@see AuthChoice}.