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/auth -H 'Accept: application/json'

Class	Description
Yiisoft\Auth\AuthenticationMethodInterface	The interface that should be implemented by individual authentication methods.
Yiisoft\Auth\Debug\AuthenticationMethodInterfaceProxy
Yiisoft\Auth\Debug\IdentityCollector
Yiisoft\Auth\Handler\AuthenticationFailureHandler	Default authentication failure handler. Responds with "401 Unauthorized" HTTP status code.
Yiisoft\Auth\IdentityInterface	Identity is what represents a "user" that can authenticate in the application.
Yiisoft\Auth\IdentityRepositoryInterface	Identity repository is identity storage that is able to retrieve identity given an ID.
Yiisoft\Auth\IdentityWithTokenRepositoryInterface	Identity repository is identity storage that is able to retrieve identity given a token.
Yiisoft\Auth\Method\Composite	Composite allows multiple authentication methods at the same time.
Yiisoft\Auth\Method\HttpBasic	HTTP Basic authentication method.
Yiisoft\Auth\Method\HttpBearer	Authentication method based on HTTP Bearer token.
Yiisoft\Auth\Method\HttpCookie	HTTP cookie authentication method.
Yiisoft\Auth\Method\HttpHeader	HttpHeader supports HTTP authentication through HTTP Headers.
Yiisoft\Auth\Method\QueryParameter	QueryParameter supports the authentication based on the access token passed through a query parameter.
Yiisoft\Auth\Middleware\Authentication	Authentication middleware tries to authenticate and identity using request data.