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

Class Description
Yiisoft\Input\Http\AbstractInput A base class for all validated request input DTOs.
Yiisoft\Input\Http\Attribute\Data\FromBody Take data for the input DTO from the request body.
Yiisoft\Input\Http\Attribute\Data\FromBodyResolver Resolver for {@see FromBody} attribute.
Yiisoft\Input\Http\Attribute\Data\FromQuery Take data for the input DTO from the query string.
Yiisoft\Input\Http\Attribute\Data\FromQueryResolver Resolver for {@see FromQuery} attribute.
Yiisoft\Input\Http\Attribute\Parameter\Body Take data for the property or attribute from the request body.
Yiisoft\Input\Http\Attribute\Parameter\BodyResolver Resolver for {@see Body} attribute.
Yiisoft\Input\Http\Attribute\Parameter\Query Take data for the property or attribute from the query string.
Yiisoft\Input\Http\Attribute\Parameter\QueryResolver Resolver for {@see Query} attribute.
Yiisoft\Input\Http\Attribute\Parameter\Request Take data for the property or attribute from request attributes.
Yiisoft\Input\Http\Attribute\Parameter\RequestResolver Resolver for {@see Request} attribute.
Yiisoft\Input\Http\Attribute\Parameter\UploadedFiles Take data for the property or attribute from uploaded files.
Yiisoft\Input\Http\Attribute\Parameter\UploadedFilesResolver Resolver for {@see UploadedFiles} attribute.
Yiisoft\Input\Http\HydratorAttributeParametersResolver HydratorAttributeParametersResolver resolves middleware parameters with hydrator parameter attributes.
Yiisoft\Input\Http\InputValidationException InputValidationException is thrown when input validation fails and contains a validation result.
Yiisoft\Input\Http\RequestInputInterface RequestInputInterface marks a DTO as a request input.
Yiisoft\Input\Http\RequestInputParametersResolver Resolves request input parameters.