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

Class Description
Yiisoft\Data\Paginator\InvalidPageException Thrown when the page is invalid.
Yiisoft\Data\Paginator\KeysetFilterContext
Yiisoft\Data\Paginator\KeysetPaginator Keyset paginator.
Yiisoft\Data\Paginator\OffsetPaginator Offset paginator.
Yiisoft\Data\Paginator\PageNotFoundException
Yiisoft\Data\Paginator\PageToken
Yiisoft\Data\Paginator\PaginatorInterface Paginator interface defines a common pagination methods shared by all pagination types.
Yiisoft\Data\Processor\DataProcessorException Exception occurred during data processing.
Yiisoft\Data\Processor\DataProcessorInterface Data processor takes an iterator with source items and produces an iterator with processed items.
Yiisoft\Data\Reader\CountableDataInterface Data that could be counted.
Yiisoft\Data\Reader\DataReaderException Exception occurred during reading data.
Yiisoft\Data\Reader\DataReaderInterface Data reader is a data source that can do the following with data items:
Yiisoft\Data\Reader\FilterInterface Filter is a set of settings for modifying data reader criteria.
Yiisoft\Data\Reader\Filter\All Represents a filter that matches all items.
Yiisoft\Data\Reader\Filter\AndX AndX filter allows combining multiple sub-filters using "AND" operator.
Yiisoft\Data\Reader\Filter\Between Between filter defines a criteria, so the value of the field with a given name is between the minimal value and the maximal value.
Yiisoft\Data\Reader\Filter\Compare Compare filter is a base class that defines a criteria for comparing field value with a given value.
Yiisoft\Data\Reader\Filter\Equals Equals filter defines a criteria for ensuring field value equals a given value.
Yiisoft\Data\Reader\Filter\EqualsNull EqualsNull filter defines a criteria for ensuring field value is null.
Yiisoft\Data\Reader\Filter\GreaterThan GreaterThan filter defines a criteria for ensuring field value is greater than a given value.
Yiisoft\Data\Reader\Filter\GreaterThanOrEqual GreaterThanOrEqual filter defines a criteria for ensuring field value is greater than or equal to a given value.
Yiisoft\Data\Reader\Filter\In In filter defines a criteria for ensuring field value matches one of the value provided.
Yiisoft\Data\Reader\Filter\LessThan LessThan filter defines a criteria for ensuring field value is less than a given value.
Yiisoft\Data\Reader\Filter\LessThanOrEqual LessThanOrEqual filter defines a criteria for ensuring field value is less than or equal to a given value.
Yiisoft\Data\Reader\Filter\Like Like filter defines a criteria for ensuring field value is like-match to a given value.
Yiisoft\Data\Reader\Filter\None Represents a filter that matches no items.
Yiisoft\Data\Reader\Filter\Not Not filter negates another filter.
Yiisoft\Data\Reader\Filter\OrX OrX filter allows combining multiple sub-filters using "OR" operator.
Yiisoft\Data\Reader\FilterableDataInterface Data that could be filtered.
Yiisoft\Data\Reader\Iterable\Context
Yiisoft\Data\Reader\Iterable\FilterHandler\AllHandler Handles the {@see All} filter for iterable data readers.
Yiisoft\Data\Reader\Iterable\FilterHandler\AndXHandler AndX iterable filter handler allows combining multiple sub-filters.
Yiisoft\Data\Reader\Iterable\FilterHandler\BetweenHandler Between iterable filter handler checks that the item's field value is between minimal and maximal values.
Yiisoft\Data\Reader\Iterable\FilterHandler\EqualsHandler Equals iterable filter handler checks that the item's field value matches the given value.
Yiisoft\Data\Reader\Iterable\FilterHandler\EqualsNullHandler EqualsNull iterable filter handler checks that the item's field value is null.
Yiisoft\Data\Reader\Iterable\FilterHandler\GreaterThanHandler GreaterThan iterable filter handler checks that the item's field value is greater than the given value.
Yiisoft\Data\Reader\Iterable\FilterHandler\GreaterThanOrEqualHandler GreaterThanOrEqual iterable filter handler checks that the item's field value is greater than or equal to the given value.
Yiisoft\Data\Reader\Iterable\FilterHandler\InHandler In iterable filter handler ensures that the field value matches one of the value provided.
Yiisoft\Data\Reader\Iterable\FilterHandler\LessThanHandler LessThan iterable filter handler checks that the item's field value is less than the given value.
Yiisoft\Data\Reader\Iterable\FilterHandler\LessThanOrEqualHandler LessThanOrEqual iterable filter handler checks that the item's field value is less than or equal to the given value.
Yiisoft\Data\Reader\Iterable\FilterHandler\LikeHandler Like iterable filter handler ensures that the field value is like-match to a given value (case-sensitive).
Yiisoft\Data\Reader\Iterable\FilterHandler\NoneHandler Handles the {@see None} filter for iterable data readers.
Yiisoft\Data\Reader\Iterable\FilterHandler\NotHandler Not iterable filter handler negates another filter.
Yiisoft\Data\Reader\Iterable\FilterHandler\OrXHandler OrX iterable filter handler allows combining multiple sub-filters.
Yiisoft\Data\Reader\Iterable\IterableDataReader Iterable data reader takes iterable data as a source and can:
Yiisoft\Data\Reader\Iterable\IterableFilterHandlerInterface Iterable filter handler checks whether an item matches criteria defined in the filter with the same operator.
Yiisoft\Data\Reader\Iterable\ValueReader\FlatValueReader
Yiisoft\Data\Reader\Iterable\ValueReader\PathValueReader
Yiisoft\Data\Reader\Iterable\ValueReader\ValueReaderInterface
Yiisoft\Data\Reader\LimitableDataInterface Data that could be limited.
Yiisoft\Data\Reader\OffsetableDataInterface Data that could be read from Nth item by skipping items from the beginning.
Yiisoft\Data\Reader\OrderHelper
Yiisoft\Data\Reader\ReadableDataInterface Readable data is a data set that could be read up by getting an iterator or reading one item from a set.
Yiisoft\Data\Reader\Sort Sort represents data sorting settings:
Yiisoft\Data\Reader\SortableDataInterface A data set that could be sorted.
Yiisoft\Data\Writer\DataWriterException Exception occurred during writing or deleting data.
Yiisoft\Data\Writer\DataWriterInterface A data writer is able to write or delete data items.
Yiisoft\Data\Writer\DeletableInterface Deletable allows deleting a set of items.
Yiisoft\Data\Writer\WriteableInterface Writable allows writing a set of items.