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

Class Description
Yiisoft\Yii\DataView\BaseListView BaseListView is an abstract base class for {@see GridView} and {@see ListView} only.
Yiisoft\Yii\DataView\DataReaderNotSetException Exception thrown when attempting to create a data view widget without setting a data reader.
Yiisoft\Yii\DataView\DetailView\DataField DataField represents a field configuration for {@see DetailView} widget.
Yiisoft\Yii\DataView\DetailView\DetailView DetailView displays details about a single data item. The data can be either an object or an associative array.
Yiisoft\Yii\DataView\DetailView\FieldContext The context of a field to be rendered.
Yiisoft\Yii\DataView\DetailView\GetValueContext Context for a callable that is passed to {@see DataField::getValue()}.
Yiisoft\Yii\DataView\DetailView\LabelContext The context of a label to be rendered.
Yiisoft\Yii\DataView\DetailView\ValueContext The context for value rendering.
Yiisoft\Yii\DataView\Filter\Factory\EqualsFilterFactory Factory for creating equality filters that match exact values.
Yiisoft\Yii\DataView\Filter\Factory\FilterFactoryInterface Interface for creating data reader filters.
Yiisoft\Yii\DataView\Filter\Factory\IncorrectValueException Exception thrown when a filter value is not in the expected format.
Yiisoft\Yii\DataView\Filter\Factory\LikeFilterFactory Factory for creating pattern matching (LIKE) filters.
Yiisoft\Yii\DataView\Filter\Widget\Context Context for filter widgets that provides necessary data for rendering filter inputs.
Yiisoft\Yii\DataView\Filter\Widget\DropdownFilter Filter widget that renders a dropdown (select) input for filtering data.
Yiisoft\Yii\DataView\Filter\Widget\FilterWidget Base class for filter widgets that render filter inputs in data views.
Yiisoft\Yii\DataView\Filter\Widget\TextInputFilter Filter widget that renders a text input for filtering data.
Yiisoft\Yii\DataView\GridView\BodyRowContext BodyRowContext provides contextual information for rendering a table body row in data views.
Yiisoft\Yii\DataView\GridView\Column\ActionButton ActionButton represents a button in an action column of a grid.
Yiisoft\Yii\DataView\GridView\Column\ActionColumn ActionColumn is a column for the {@see GridView} widget that displays buttons for viewing and manipulating the items.
Yiisoft\Yii\DataView\GridView\Column\ActionColumnRenderer ActionColumnRenderer renders action buttons in a grid column.
Yiisoft\Yii\DataView\GridView\Column\Base\Cell Cell represents a single grid cell with content and attributes.
Yiisoft\Yii\DataView\GridView\Column\Base\DataContext DataContext provides context information for rendering a data cell in a grid.
Yiisoft\Yii\DataView\GridView\Column\Base\FilterContext FilterContext provides context information for rendering and handling grid column filters.
Yiisoft\Yii\DataView\GridView\Column\Base\GlobalContext GlobalContext provides context for rendering and handling grid column headers, footers and container cells.
Yiisoft\Yii\DataView\GridView\Column\Base\MakeFilterContext MakeFilterContext provides context for creating and validating grid column filters.
Yiisoft\Yii\DataView\GridView\Column\Base\RendererContainer RendererContainer manages the creation and configuration of column renderers.
Yiisoft\Yii\DataView\GridView\Column\CheckboxColumn CheckboxColumn displays a column of checkboxes in a grid view.
Yiisoft\Yii\DataView\GridView\Column\CheckboxColumnRenderer CheckboxColumnRenderer renders checkbox inputs in a grid column.
Yiisoft\Yii\DataView\GridView\Column\ColumnInterface Interface defining the contract for grid columns.
Yiisoft\Yii\DataView\GridView\Column\ColumnRendererInterface Interface for column renderers that handle the visual presentation of grid columns.
Yiisoft\Yii\DataView\GridView\Column\DataColumn DataColumn is the default column type for the {@see GridView} widget.
Yiisoft\Yii\DataView\GridView\Column\DataColumnRenderer DataColumnRenderer handles rendering and filtering of data columns in a grid.
Yiisoft\Yii\DataView\GridView\Column\FilterableColumnRendererInterface Interface for column renderers that support filtering functionality.
Yiisoft\Yii\DataView\GridView\Column\RadioColumn RadioColumn displays a column of radio buttons in a grid view.
Yiisoft\Yii\DataView\GridView\Column\RadioColumnRenderer RadioColumnRenderer handles the rendering of radio button columns in a grid.
Yiisoft\Yii\DataView\GridView\Column\SerialColumn SerialColumn displays a column of sequential row numbers (1-based) in a grid view.
Yiisoft\Yii\DataView\GridView\Column\SerialColumnRenderer SerialColumnRenderer handles the rendering of sequential row number columns in a grid.
Yiisoft\Yii\DataView\GridView\Column\SortableColumnRendererInterface Interface for column renderers that support sorting functionality.
Yiisoft\Yii\DataView\GridView\GridView The GridView widget displays data in a grid.
Yiisoft\Yii\DataView\ListView\ListItemContext ListItemContext provides contextual information about the current item being rendered in a {@see ListView}.
Yiisoft\Yii\DataView\ListView\ListView ListView is a flexible widget for displaying a list of data items with customizable rendering and layout.
Yiisoft\Yii\DataView\PageSize\InputPageSize Widget that renders a text input for setting the page size.
Yiisoft\Yii\DataView\PageSize\PageSizeContext Context class that holds the state and configuration for page size widgets.
Yiisoft\Yii\DataView\PageSize\PageSizeContextTrait Trait providing context management functionality for page size widgets.
Yiisoft\Yii\DataView\PageSize\PageSizeWidgetInterface Interface for widgets that allow users to control the number of items displayed per page.
Yiisoft\Yii\DataView\PageSize\SelectPageSize Widget that renders a dropdown (select) input for choosing the page size.
Yiisoft\Yii\DataView\Pagination\KeysetPagination Widget for rendering {@see KeysetPaginator}.
Yiisoft\Yii\DataView\Pagination\OffsetPagination Widget for rendering {@see OffsetPaginator}.
Yiisoft\Yii\DataView\Pagination\PaginationContext Context class for pagination widgets that provides URL generation and configuration.
Yiisoft\Yii\DataView\Pagination\PaginationContextTrait Trait providing context management functionality for pagination widgets.
Yiisoft\Yii\DataView\Pagination\PaginationWidgetInterface Interface for widgets that render pagination controls.
Yiisoft\Yii\DataView\Pagination\PaginatorNotSetException Exception thrown when attempting to use a pagination widget without setting a paginator.
Yiisoft\Yii\DataView\Pagination\PaginatorNotSupportedException Exception thrown when a pagination widget receives an unsupported paginator type.
Yiisoft\Yii\DataView\Url\NullUrlParameterProvider
Yiisoft\Yii\DataView\Url\UrlConfig UrlConfig provides configuration for URL parameter handling in data views.
Yiisoft\Yii\DataView\Url\UrlParameterProviderInterface UrlParameterProviderInterface defines a contract for retrieving URL parameters.
Yiisoft\Yii\DataView\Url\UrlParametersFactory Factory for creating URL parameters for data view components.
Yiisoft\Yii\DataView\ValuePresenter\SimpleValuePresenter Presents scalars and Stringable objects as strings.
Yiisoft\Yii\DataView\ValuePresenter\ValuePresenterInterface A value presenter is responsible for presenting a given value as a string.
Yiisoft\Yii\DataView\YiiRouter\ActionColumnUrlConfig Configuration class for generating URLs in action columns.
Yiisoft\Yii\DataView\YiiRouter\ActionColumnUrlCreator URL creator for action columns in GridView.
Yiisoft\Yii\DataView\YiiRouter\UrlCreator URL creator for list views that generates URLs based on the current route.
Yiisoft\Yii\DataView\YiiRouter\UrlParameterProvider Provider for accessing URL parameters from both path and query string.