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 Yiisoft\DataResponse\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\DataStream\DataStream A lazy stream that formats data only when it's being read.
Yiisoft\DataResponse\DataStream\StringStream A read-only stream implementation for string content.
Yiisoft\DataResponse\Formatter\DataEncodingException Exception thrown when data encoding fails during response formatting.
Yiisoft\DataResponse\Formatter\FormatterInterface Interface that should be implemented by data formatters.
Yiisoft\DataResponse\Formatter\HtmlDataResponseFormatter HtmlDataResponseFormatter formats the response data as HTML.
Yiisoft\DataResponse\Formatter\HtmlFormatter Formatter that converts data to HTML and sets appropriate response headers.
Yiisoft\DataResponse\Formatter\JsonDataResponseFormatter JsonDataResponseFormatter formats the response data as JSON.
Yiisoft\DataResponse\Formatter\JsonFormatter Formatter that encodes data as JSON and sets appropriate response headers.
Yiisoft\DataResponse\Formatter\PlainTextDataResponseFormatter PlainTextDataResponseFormatter formats the response data as plain text.
Yiisoft\DataResponse\Formatter\PlainTextFormatter Formatter that converts data to plain text and sets appropriate response headers.
Yiisoft\DataResponse\Formatter\XmlDataInterface Interface provides methods used when formatting objects Yiisoft\DataResponse\Formatter\XmlFormatter as XML data.
Yiisoft\DataResponse\Formatter\XmlDataResponseFormatter XmlDataResponseFormatter formats the response data as XML.
Yiisoft\DataResponse\Formatter\XmlFormatter Formatter that encodes data as XML and sets appropriate response headers.
Yiisoft\DataResponse\Middleware\AbstractDataResponseMiddleware Abstract middleware class that applies a formatter to Yiisoft\DataResponse\DataStream\DataStream responses and sets appropriate response headers.
Yiisoft\DataResponse\Middleware\ContentNegotiator ContentNegotiator supports response format negotiation.
Yiisoft\DataResponse\Middleware\ContentNegotiatorDataResponseMiddleware Middleware that selects a formatter for Yiisoft\DataResponse\DataStream\DataStream responses based on the request's Accept header and sets appropriate response headers.
Yiisoft\DataResponse\Middleware\DataResponseMiddleware Middleware that applies a custom formatter to Yiisoft\DataResponse\DataStream\DataStream responses and sets appropriate response headers.
Yiisoft\DataResponse\Middleware\FormatDataResponse FormatDataResponse adds a formatter Yiisoft\DataResponse\DataResponseFormatterInterface instance to the instance of the data response Yiisoft\DataResponse\DataResponse, if the formatter was not added earlier.
Yiisoft\DataResponse\Middleware\FormatDataResponseAsHtml FormatDataResponseAsHtml adds an HTML formatter Yiisoft\DataResponse\Formatter\HtmlDataResponseFormatter instance to the instance of the data response Yiisoft\DataResponse\DataResponse, if the formatter was not added earlier.
Yiisoft\DataResponse\Middleware\FormatDataResponseAsJson FormatDataResponseAsJson adds a JSON formatter Yiisoft\DataResponse\Formatter\JsonDataResponseFormatter instance to the instance of the data response Yiisoft\DataResponse\DataResponse, if the formatter was not added earlier.
Yiisoft\DataResponse\Middleware\FormatDataResponseAsPlainText FormatDataResponseAsPlainText adds a plain text formatter Yiisoft\DataResponse\Formatter\PlainTextDataResponseFormatter instance to the instance of the data response Yiisoft\DataResponse\DataResponse, if the formatter was not added earlier.
Yiisoft\DataResponse\Middleware\FormatDataResponseAsXml FormatDataResponseAsXml adds an XML formatter Yiisoft\DataResponse\Formatter\XmlDataResponseFormatter instance to the instance of the data response Yiisoft\DataResponse\DataResponse, if the formatter was not added earlier.
Yiisoft\DataResponse\Middleware\HtmlDataResponseMiddleware Middleware that formats Yiisoft\DataResponse\DataStream\DataStream responses as HTML and sets appropriate response headers.
Yiisoft\DataResponse\Middleware\JsonDataResponseMiddleware Middleware that formats Yiisoft\DataResponse\DataStream\DataStream responses as JSON and sets appropriate response headers.
Yiisoft\DataResponse\Middleware\PlainTextDataResponseMiddleware Middleware that formats Yiisoft\DataResponse\DataStream\DataStream responses as plain text and sets appropriate response headers.
Yiisoft\DataResponse\Middleware\XmlDataResponseMiddleware Middleware that formats Yiisoft\DataResponse\DataStream\DataStream responses as XML and sets appropriate response headers.
Yiisoft\DataResponse\NotAcceptableRequestHandler Returns a 406 Not Acceptable response.
Yiisoft\DataResponse\ResponseContentTrait ResponseContentTrait provides methods for manipulating the response content.
Yiisoft\DataResponse\ResponseFactory\AbstractFormattedResponseFactory Abstract factory class that creates responses with pre-formatted Yiisoft\DataResponse\DataStream\DataStream body and appropriate response headers.
Yiisoft\DataResponse\ResponseFactory\ContentNegotiatorResponseFactory Factory that selects a response factory based on the request's Accept header.
Yiisoft\DataResponse\ResponseFactory\DataResponseFactory Factory that creates responses with Yiisoft\DataResponse\DataStream\DataStream body without applying a formatter.
Yiisoft\DataResponse\ResponseFactory\DataResponseFactoryInterface Interface for factories that create HTTP responses with Yiisoft\DataResponse\DataStream\DataStream body.
Yiisoft\DataResponse\ResponseFactory\FormattedResponseFactory Factory that creates responses with a custom formatter applied to the Yiisoft\DataResponse\DataStream\DataStream body and appropriate response headers.
Yiisoft\DataResponse\ResponseFactory\HtmlResponseFactory Factory that creates responses with HTML-formatted Yiisoft\DataResponse\DataStream\DataStream body and appropriate response headers.
Yiisoft\DataResponse\ResponseFactory\JsonResponseFactory Factory that creates responses with JSON-formatted Yiisoft\DataResponse\DataStream\DataStream body and appropriate response headers.
Yiisoft\DataResponse\ResponseFactory\PlainTextResponseFactory Factory that creates responses with plain text formatted Yiisoft\DataResponse\DataStream\DataStream body and appropriate response headers.
Yiisoft\DataResponse\ResponseFactory\XmlResponseFactory Factory that creates responses with XML-formatted Yiisoft\DataResponse\DataStream\DataStream body and appropriate response headers.