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

Class Description
Yiisoft\User\CurrentUser Maintains current identity and allows logging in and out using it.
Yiisoft\User\Event\AfterLogin
Yiisoft\User\Event\AfterLogout
Yiisoft\User\Event\BeforeLogin
Yiisoft\User\Event\BeforeLogout
Yiisoft\User\Guest\GuestIdentity Default implementation of the identity interface for a guest non-authenticated user.
Yiisoft\User\Guest\GuestIdentityFactory Creates a default implementation of the identity interface for a guest non-authenticated user.
Yiisoft\User\Guest\GuestIdentityFactoryInterface Implementations should create instances of the identity interface for a guest non-authenticated user.
Yiisoft\User\Guest\GuestIdentityInterface Identity interface for a guest non-authenticated user.
Yiisoft\User\Login\Cookie\CookieLogin The service is used to send or remove auto-login cookie.
Yiisoft\User\Login\Cookie\CookieLoginIdentityInterface CookieLoginIdentityInterface should be implemented in order to automatically log user in based on a cookie.
Yiisoft\User\Login\Cookie\CookieLoginMiddleware CookieLoginMiddleware automatically logs user in based on cookie.
Yiisoft\User\Login\LoginMiddleware LoginMiddleware automatically logs user in if {@see IdentityInterface} instance presents in a request attribute. It is usually put there by {@see Authentication}.
Yiisoft\User\Method\ApiAuth Implementation of the AuthenticationMethodInterface for authenticating users in the API clients.
Yiisoft\User\Method\WebAuth Implementation of the AuthenticationMethodInterface for authenticating users in the web applications.
Yiisoft\User\UserAuth Implementation of the authentication interface for the user.