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

Class Description
Yiisoft\HttpMiddleware\ContentLengthMiddleware Configurable middleware that adds or removes the Content-Length header from the response.
Yiisoft\HttpMiddleware\CorsAllowAllMiddleware Adds Cross-Origin Resource Sharing (CORS) headers allowing everything to the response.
Yiisoft\HttpMiddleware\ForceSecureConnection\ForceSecureConnectionMiddleware Redirects insecure requests from HTTP to HTTPS and adds headers necessary to enhance the security policy.
Yiisoft\HttpMiddleware\ForceSecureConnection\HstsHeader Represents the Strict-Transport-Security header.
Yiisoft\HttpMiddleware\ForceSecureConnection\RedirectOptions Redirection HTTP to HTTPS options.
Yiisoft\HttpMiddleware\HeadRequestMiddleware Middleware removes the body from response for HEAD requests.
Yiisoft\HttpMiddleware\HttpCache\CacheControlProvider\CacheControlProviderInterface Interface for Cache-Control header value providers. Given a request, it generates a header value.
Yiisoft\HttpMiddleware\HttpCache\CacheControlProvider\ConstantCacheControlProvider Returns a predefined cache control header value regardless of request.
Yiisoft\HttpMiddleware\HttpCache\CacheControlProvider\NullCacheControlProvider Returns null regardless of request.
Yiisoft\HttpMiddleware\HttpCache\ETag Represents an ETag (Entity Tag) used for HTTP caching.
Yiisoft\HttpMiddleware\HttpCache\ETagGenerator\CallableETagGenerator Generates a string ETag value using a callable function.
Yiisoft\HttpMiddleware\HttpCache\ETagGenerator\DefaultETagGenerator Generates a string ETag value using PHP native functions {@see base64_encode()} and {@see sha1()}.
Yiisoft\HttpMiddleware\HttpCache\ETagGenerator\ETagGeneratorInterface Interface defines a method to generate a string ETag value based on a given seed string.
Yiisoft\HttpMiddleware\HttpCache\ETagHeader
Yiisoft\HttpMiddleware\HttpCache\ETagProvider\ETagProviderInterface Obtains {@see ETag} for a given server request.
Yiisoft\HttpMiddleware\HttpCache\ETagProvider\NullETagProvider Returns null ETag for all requests.
Yiisoft\HttpMiddleware\HttpCache\ETagProvider\PredefinedETagProvider Provides {@see ETag} from a predefined collection. Useful for testing purposes.
Yiisoft\HttpMiddleware\HttpCache\HttpCacheMiddleware Middleware that implements HTTP caching using Cache-Control, ETag, and Last-Modified headers.
Yiisoft\HttpMiddleware\HttpCache\LastModifiedProvider\LastModifiedProviderInterface Provides last modified date given a server request.
Yiisoft\HttpMiddleware\HttpCache\LastModifiedProvider\NullLastModifiedProvider Returns null for all requests.
Yiisoft\HttpMiddleware\HttpCache\LastModifiedProvider\PredefinedLastModifiedProvider Provides dates from a predefined collection. Useful for testing purposes.
Yiisoft\HttpMiddleware\RemoveBodyMiddleware Removes the body from the response for specific HTTP status codes.
Yiisoft\HttpMiddleware\TagRequest\TagProvider\PredefinedTagProvider Provides tags from a predefined collection. Useful for testing purposes.
Yiisoft\HttpMiddleware\TagRequest\TagProvider\PrefixedTagProvider A tag provider that prefixes the result of a decorated tag provider with a specified string.
Yiisoft\HttpMiddleware\TagRequest\TagProvider\TagProviderInterface Provides a tag for a request.
Yiisoft\HttpMiddleware\TagRequest\TagProvider\TimeBasedTagProvider Represents a tag provider that generates a unique tag based on the current time and additional entropy.
Yiisoft\HttpMiddleware\TagRequest\TagRequestMiddleware Tags request with a value that could be later used for identifying it.