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

Class Description
Yiisoft\DataResponse\DataResponse A wrapper around PSR-7 response that is assigned raw data to be formatted with a formatter later.
Yiisoft\DataResponse\DataResponseFactory DataResponseFactory creates an instance of the data response {@see DataResponse}.
Yiisoft\DataResponse\DataResponseFactoryInterface DataResponseFactoryInterface is the interface that should be implemented by data response factory classes.
Yiisoft\DataResponse\DataResponseFormatterInterface DataResponseFormatterInterface is the interface that should be implemented by data response formatters.
Yiisoft\DataResponse\Formatter\HtmlDataResponseFormatter HtmlDataResponseFormatter formats the response data as HTML.
Yiisoft\DataResponse\Formatter\JsonDataResponseFormatter JsonDataResponseFormatter formats the response data as JSON.
Yiisoft\DataResponse\Formatter\PlainTextDataResponseFormatter PlainTextDataResponseFormatter formats the response data as plain text.
Yiisoft\DataResponse\Formatter\XmlDataInterface XmlFormatDataInterface provides methods used when formatting objects {@see XmlDataResponseFormatter} as XML data.
Yiisoft\DataResponse\Formatter\XmlDataResponseFormatter XmlDataResponseFormatter formats the response data as XML.
Yiisoft\DataResponse\Middleware\ContentNegotiator ContentNegotiator supports response format negotiation.
Yiisoft\DataResponse\Middleware\FormatDataResponse FormatDataResponse adds a formatter {@see DataResponseFormatterInterface} instance to the instance of the data response {@see DataResponse}, if the formatter was not added earlier.
Yiisoft\DataResponse\Middleware\FormatDataResponseAsHtml FormatDataResponseAsHtml adds an HTML formatter {@see HtmlDataResponseFormatter} instance to the instance of the data response {@see DataResponse}, if the formatter was not added earlier.
Yiisoft\DataResponse\Middleware\FormatDataResponseAsJson FormatDataResponseAsJson adds a JSON formatter {@see JsonDataResponseFormatter} instance to the instance of the data response {@see DataResponse}, if the formatter was not added earlier.
Yiisoft\DataResponse\Middleware\FormatDataResponseAsPlainText FormatDataResponseAsPlainText adds a plain text formatter {@see PlainTextDataResponseFormatter} instance to the instance of the data response {@see DataResponse}, if the formatter was not added earlier.
Yiisoft\DataResponse\Middleware\FormatDataResponseAsXml FormatDataResponseAsXml adds an XML formatter {@see XmlDataResponseFormatter} instance to the instance of the data response {@see DataResponse}, if the formatter was not added earlier.
Yiisoft\DataResponse\ResponseContentTrait ResponseContentTrait provides methods for manipulating the response content.