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

Class Description
Yiisoft\Yii\Middleware\CorsAllowAll Adds Cross-Origin Resource Sharing (CORS) headers allowing everything to the response.
Yiisoft\Yii\Middleware\Event\SetLocaleEvent Raised when {@see Locale} middleware have determined the locale to use.
Yiisoft\Yii\Middleware\Exception\BadUriPrefixException
Yiisoft\Yii\Middleware\Exception\InvalidLocalesFormatException
Yiisoft\Yii\Middleware\ForceSecureConnection Redirects insecure requests from HTTP to HTTPS, and adds headers necessary to enhance the security policy.
Yiisoft\Yii\Middleware\HttpCache HttpCache implements client-side caching by utilizing the Last-Modified and ETag HTTP headers.
Yiisoft\Yii\Middleware\IpFilter IpFilter allows access from specified IP ranges only and responds with 403 for all other IPs.
Yiisoft\Yii\Middleware\Locale Locale middleware supports locale-based routing and configures URL generator. With {@see SetLocaleEvent} it's also possible to configure locale in other services such as translator or session.
Yiisoft\Yii\Middleware\Redirect This middleware generates and adds a Location header to the response.
Yiisoft\Yii\Middleware\Subfolder This middleware supports routing when the entry point of the application isn't directly at the webroot.
Yiisoft\Yii\Middleware\TagRequest Tags request with a random value that could be later used for identifying it.