25 followers

Yii Framework 2.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 2.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().

You may download the API documentation for offline use:

This page is also available in JSON format:
curl https://www.yiiframework.com/doc/api/2.0 -H 'Accept: application/json'

Class Description
Yii Yii is a helper class serving common framework functionalities.
YiiRequirementChecker YiiRequirementChecker allows checking, if current system meets the requirements for running the Yii application.
yii\BaseYii BaseYii is the core helper class for the Yii framework.
yii\base\Action Action is the base class for all controller action classes.
yii\base\ActionEvent ActionEvent represents the event parameter used for an action event.
yii\base\ActionFilter ActionFilter is the base class for action filters.
yii\base\Application Application is the base class for all application classes.
yii\base\ArrayAccessTrait ArrayAccessTrait provides the implementation for IteratorAggregate, ArrayAccess and Countable.
yii\base\Arrayable Arrayable is the interface that should be implemented by classes who want to support customizable representation of their instances.
yii\base\ArrayableTrait ArrayableTrait provides a common implementation of the yii\base\Arrayable interface.
yii\base\BaseObject BaseObject is the base class that implements the property feature.
yii\base\Behavior Behavior is the base class for all behavior classes.
yii\base\BootstrapInterface BootstrapInterface is the interface that should be implemented by classes who want to participate in the application bootstrap process.
yii\base\Component Component is the base class that implements the property, event and behavior features.
yii\base\Configurable Configurable is the interface that should be implemented by classes who support configuring its properties through the last parameter to its constructor.
yii\base\Controller Controller is the base class for classes containing controller logic.
yii\base\DynamicContentAwareInterface DynamicContentAwareInterface is the interface that should be implemented by classes which support a yii\base\View dynamic content feature.
yii\base\DynamicContentAwareTrait DynamicContentAwareTrait implements common methods for classes which support a yii\base\View dynamic content feature.
yii\base\DynamicModel DynamicModel is a model class that supports defining attributes at run-time (the so-called "dynamic attributes") using its constructor or defineAttribute(). DynamicModel can be used to support ad hoc data validation.
yii\base\ErrorException ErrorException represents a PHP error.
yii\base\ErrorHandler ErrorHandler handles uncaught PHP errors and exceptions.
yii\base\Event Event is the base class for all event classes.
yii\base\Exception Exception represents a generic exception for all purposes.
yii\base\ExitException ExitException represents a normal termination of an application.
yii\base\InlineAction InlineAction represents an action that is defined as a controller method.
yii\base\InvalidArgumentException InvalidArgumentException represents an exception caused by invalid arguments passed to a method.
yii\base\InvalidCallException InvalidCallException represents an exception caused by calling a method in a wrong way.
yii\base\InvalidConfigException InvalidConfigException represents an exception caused by incorrect object configuration.
yii\base\InvalidParamException InvalidParamException represents an exception caused by invalid parameters passed to a method.
yii\base\InvalidRouteException InvalidRouteException represents an exception caused by an invalid route.
yii\base\InvalidValueException InvalidValueException represents an exception caused by a function returning a value of unexpected type.
yii\base\Model Model is the base class for data models.
yii\base\ModelEvent ModelEvent represents the parameter needed by yii\base\Model events.
yii\base\Module Module is the base class for module and application classes.
yii\base\NotSupportedException NotSupportedException represents an exception caused by accessing features that are not supported.
yii\base\Object Object is the base class that implements the property feature.
yii\base\Request Request represents a request that is handled by an yii\base\Application.
yii\base\Response Response represents the response of an yii\base\Application to a yii\base\Request.
yii\base\Security Security provides a set of methods to handle common security-related tasks.
yii\base\StaticInstanceInterface StaticInstanceInterface is the interface for providing static instances to classes, which can be used to obtain class meta information that can not be expressed in static methods.
yii\base\StaticInstanceTrait StaticInstanceTrait provides methods to satisfy yii\base\StaticInstanceInterface interface.
yii\base\Theme Theme represents an application theme.
yii\base\UnknownClassException UnknownClassException represents an exception caused by using an unknown class.
yii\base\UnknownMethodException UnknownMethodException represents an exception caused by accessing an unknown object method.
yii\base\UnknownPropertyException UnknownPropertyException represents an exception caused by accessing unknown object properties.
yii\base\UserException UserException is the base class for exceptions that are meant to be shown to end users.
yii\base\View View represents a view object in the MVC pattern.
yii\base\ViewContextInterface ViewContextInterface is the interface that should implemented by classes who want to support relative view names.
yii\base\ViewEvent ViewEvent represents events triggered by the yii\base\View component.
yii\base\ViewNotFoundException ViewNotFoundException represents an exception caused by view file not found.
yii\base\ViewRenderer ViewRenderer is the base class for view renderer classes.
yii\base\Widget Widget is the base class for widgets.
yii\base\WidgetEvent WidgetEvent represents the event parameter used for a widget event.
yii\behaviors\AttributeBehavior AttributeBehavior automatically assigns a specified value to one or multiple attributes of an ActiveRecord object when certain events happen.
yii\behaviors\AttributeTypecastBehavior AttributeTypecastBehavior provides an ability of automatic model attribute typecasting.
yii\behaviors\AttributesBehavior AttributesBehavior automatically assigns values specified to one or multiple attributes of an ActiveRecord object when certain events happen.
yii\behaviors\BlameableBehavior BlameableBehavior automatically fills the specified attributes with the current user ID.
yii\behaviors\CacheableWidgetBehavior Cacheable widget behavior automatically caches widget contents according to duration and dependencies specified.
yii\behaviors\OptimisticLockBehavior OptimisticLockBehavior automatically upgrades a model's lock version using the column name returned by optimisticLock().
yii\behaviors\SluggableBehavior SluggableBehavior automatically fills the specified attribute with a value that can be used a slug in a URL.
yii\behaviors\TimestampBehavior TimestampBehavior automatically fills the specified attributes with the current timestamp.
yii\caching\ApcCache ApcCache provides APC caching in terms of an application component.
yii\caching\ArrayCache ArrayCache provides caching for the current request only by storing the values in an array.
yii\caching\Cache Cache is the base class for cache classes supporting different cache storage implementations.
yii\caching\CacheInterface CacheInterface is the base interface for cache.
yii\caching\ChainedDependency ChainedDependency represents a dependency which is composed of a list of other dependencies.
yii\caching\DbCache DbCache implements a cache application component by storing cached data in a database.
yii\caching\DbDependency DbDependency represents a dependency based on the query result of a SQL statement.
yii\caching\DbQueryDependency DbQueryDependency represents a dependency based on the query result of an yii\db\QueryInterface instance.
yii\caching\Dependency Dependency is the base class for cache dependency classes.
yii\caching\DummyCache DummyCache is a placeholder cache component.
yii\caching\ExpressionDependency ExpressionDependency represents a dependency based on the result of a PHP expression.
yii\caching\FileCache FileCache implements a cache component using files.
yii\caching\FileDependency FileDependency represents a dependency based on a file's last modification time.
yii\caching\MemCache MemCache implements a cache application component based on memcache and memcached.
yii\caching\MemCacheServer MemCacheServer represents the configuration data for a single memcache or memcached server.
yii\caching\TagDependency TagDependency associates a cached data item with one or multiple $tags.
yii\caching\WinCache WinCache provides Windows Cache caching in terms of an application component.
yii\caching\XCache XCache provides XCache caching in terms of an application component.
yii\caching\ZendDataCache ZendDataCache provides Zend data caching in terms of an application component.
yii\captcha\Captcha Captcha renders a CAPTCHA image and an input field that takes user-entered verification code.
yii\captcha\CaptchaAction CaptchaAction renders a CAPTCHA image.
yii\captcha\CaptchaAsset This asset bundle provides the javascript files needed for the yii\captcha\Captcha widget.
yii\captcha\CaptchaValidator CaptchaValidator validates that the attribute value is the same as the verification code displayed in the CAPTCHA.
yii\console\Application Application represents a console application.
yii\console\Controller Controller is the base class of console command classes.
yii\console\ErrorHandler ErrorHandler handles uncaught PHP errors and exceptions.
yii\console\Exception Exception represents an exception caused by incorrect usage of a console command.
yii\console\ExitCode This class provides constants for defining console command exit codes.
yii\console\Markdown A Markdown parser that enhances markdown for reading in console environments.
yii\console\Request The console Request represents the environment information for a console application.
yii\console\Response The console Response represents the result of a console application.
yii\console\UnknownCommandException UnknownCommandException represents an exception caused by incorrect usage of a console command.
yii\console\controllers\AssetController Allows you to combine and compress your JavaScript and CSS files.
yii\console\controllers\BaseMigrateController BaseMigrateController is the base class for migrate controllers.
yii\console\controllers\CacheController Allows you to flush cache.
yii\console\controllers\FixtureController Manages fixture data loading and unloading.
yii\console\controllers\HelpController Provides help information about console commands.
yii\console\controllers\MessageController Extracts messages to be translated from source files.
yii\console\controllers\MigrateController Manages application migrations.
yii\console\controllers\ServeController Runs PHP built-in web server.
yii\console\widgets\Table Table class displays a table in console.
yii\data\ActiveDataFilter ActiveDataFilter allows composing a filtering condition in a format suitable for yii\db\QueryInterface::where().
yii\data\ActiveDataProvider ActiveDataProvider implements a data provider based on yii\db\Query and yii\db\ActiveQuery.
yii\data\ArrayDataProvider ArrayDataProvider implements a data provider based on a data array.
yii\data\BaseDataProvider BaseDataProvider provides a base class that implements the yii\data\DataProviderInterface.
yii\data\DataFilter DataFilter is a special yii\base\Model for processing query filtering specification.
yii\data\DataProviderInterface DataProviderInterface is the interface that must be implemented by data provider classes.
yii\data\Pagination Pagination represents information relevant to pagination of data items.
yii\data\Sort Sort represents information relevant to sorting.
yii\data\SqlDataProvider SqlDataProvider implements a data provider based on a plain SQL statement.
yii\db\ActiveQuery ActiveQuery represents a DB query associated with an Active Record class.
yii\db\ActiveQueryInterface ActiveQueryInterface defines the common interface to be implemented by active record query classes.
yii\db\ActiveQueryTrait ActiveQueryTrait implements the common methods and properties for active record query classes.
yii\db\ActiveRecord ActiveRecord is the base class for classes representing relational data in terms of objects.
yii\db\ActiveRecordInterface ActiveRecordInterface.
yii\db\ActiveRelationTrait ActiveRelationTrait implements the common methods and properties for active record relational queries.
yii\db\AfterSaveEvent AfterSaveEvent represents the information available in yii\db\ActiveRecord::EVENT_AFTER_INSERT and yii\db\ActiveRecord::EVENT_AFTER_UPDATE.
yii\db\ArrayExpression Class ArrayExpression represents an array SQL expression.
yii\db\BaseActiveRecord ActiveRecord is the base class for classes representing relational data in terms of objects.
yii\db\BatchQueryResult BatchQueryResult represents a batch query from which you can retrieve data in batches.
yii\db\CheckConstraint CheckConstraint represents the metadata of a table CHECK constraint.
yii\db\ColumnSchema ColumnSchema class describes the metadata of a column in a database table.
yii\db\ColumnSchemaBuilder ColumnSchemaBuilder helps to define database schema types using a PHP interface.
yii\db\Command Command represents a SQL statement to be executed against a database.
yii\db\Connection Connection represents a connection to a database via PDO.
yii\db\Constraint Constraint represents the metadata of a table constraint.
yii\db\ConstraintFinderInterface ConstraintFinderInterface defines methods for getting a table constraint information.
yii\db\ConstraintFinderTrait ConstraintFinderTrait provides methods for getting a table constraint information.
yii\db\DataReader DataReader represents a forward-only stream of rows from a query result set.
yii\db\DefaultValueConstraint DefaultValueConstraint represents the metadata of a table DEFAULT constraint.
yii\db\Exception Exception represents an exception that is caused by some DB-related operations.
yii\db\Expression Expression represents a DB expression that does not need escaping or quoting.
yii\db\ExpressionBuilder Class ExpressionBuilder builds objects of yii\db\Expression class.
yii\db\ExpressionBuilderInterface Interface ExpressionBuilderInterface is designed to build raw SQL from specific expression objects that implement yii\db\ExpressionInterface.
yii\db\ExpressionBuilderTrait Trait ExpressionBuilderTrait provides common constructor for classes that should implement yii\db\ExpressionBuilderInterface
yii\db\ExpressionInterface Interface ExpressionInterface should be used to mark classes, that should be built in a special way.
yii\db\ForeignKeyConstraint ForeignKeyConstraint represents the metadata of a table FOREIGN KEY constraint.
yii\db\IndexConstraint IndexConstraint represents the metadata of a table INDEX constraint.
yii\db\IntegrityException Exception represents an exception that is caused by violation of DB constraints.
yii\db\JsonExpression Class JsonExpression represents data that should be encoded to JSON.
yii\db\Migration Migration is the base class for representing a database migration.
yii\db\MigrationInterface The MigrationInterface defines the minimum set of methods to be implemented by a database migration.
yii\db\PdoValue Class PdoValue represents a $value that should be bound to PDO with exact $type.
yii\db\PdoValueBuilder Class PdoValueBuilder builds object of the yii\db\PdoValue expression class.
yii\db\Query Query represents a SELECT SQL statement in a way that is independent of DBMS.
yii\db\QueryBuilder QueryBuilder builds a SELECT SQL statement based on the specification given as a yii\db\Query object.
yii\db\QueryExpressionBuilder Class QueryExpressionBuilder is used internally to build yii\db\Query object using unified yii\db\QueryBuilder expression building interface.
yii\db\QueryInterface The QueryInterface defines the minimum set of methods to be implemented by a database query.
yii\db\QueryTrait The BaseQuery trait represents the minimum method set of a database Query.
yii\db\Schema Schema is the base class for concrete DBMS-specific schema classes.
yii\db\SchemaBuilderTrait SchemaBuilderTrait contains shortcut methods to create instances of yii\db\ColumnSchemaBuilder.
yii\db\SqlToken SqlToken represents SQL tokens produced by yii\db\SqlTokenizer or its child classes.
yii\db\SqlTokenizer SqlTokenizer splits an SQL query into individual SQL tokens.
yii\db\StaleObjectException
yii\db\TableSchema TableSchema represents the metadata of a database table.
yii\db\Transaction Transaction represents a DB transaction.
yii\db\ViewFinderTrait ViewFinderTrait implements the method getViewNames for finding views in a database.
yii\db\conditions\AndCondition Condition that connects two or more SQL expressions with the AND operator.
yii\db\conditions\BetweenColumnsCondition Class BetweenColumnCondition represents a BETWEEN condition where values is between two columns. For example:
yii\db\conditions\BetweenColumnsConditionBuilder Class BetweenColumnsConditionBuilder builds objects of yii\db\conditions\BetweenColumnsCondition
yii\db\conditions\BetweenCondition Class BetweenCondition represents a BETWEEN condition.
yii\db\conditions\BetweenConditionBuilder Class BetweenConditionBuilder builds objects of yii\db\conditions\BetweenCondition
yii\db\conditions\ConditionInterface Interface ConditionInterface should be implemented by classes that represent a condition in DBAL of framework.
yii\db\conditions\ConjunctionCondition Class ConjunctionCondition
yii\db\conditions\ConjunctionConditionBuilder Class ConjunctionConditionBuilder builds objects of abstract class yii\db\conditions\ConjunctionCondition
yii\db\conditions\ExistsCondition Condition that represents EXISTS operator.
yii\db\conditions\ExistsConditionBuilder Class ExistsConditionBuilder builds objects of yii\db\conditions\ExistsCondition
yii\db\conditions\HashCondition Condition based on column-value pairs.
yii\db\conditions\HashConditionBuilder Class HashConditionBuilder builds objects of yii\db\conditions\HashCondition
yii\db\conditions\InCondition Class InCondition represents IN condition.
yii\db\conditions\InConditionBuilder Class InConditionBuilder builds objects of yii\db\conditions\InCondition
yii\db\conditions\LikeCondition Class LikeCondition represents a LIKE condition.
yii\db\conditions\LikeConditionBuilder Class LikeConditionBuilder builds objects of yii\db\conditions\LikeCondition
yii\db\conditions\NotCondition Condition that inverts passed condition.
yii\db\conditions\NotConditionBuilder Class NotConditionBuilder builds objects of yii\db\conditions\NotCondition
yii\db\conditions\OrCondition Condition that connects two or more SQL expressions with the AND operator.
yii\db\conditions\SimpleCondition Class SimpleCondition represents a simple condition like "column" operator value.
yii\db\conditions\SimpleConditionBuilder Class NotConditionBuilder builds objects of yii\db\conditions\SimpleCondition
yii\db\cubrid\ColumnSchemaBuilder ColumnSchemaBuilder is the schema builder for Cubrid databases.
yii\db\cubrid\QueryBuilder QueryBuilder is the query builder for CUBRID databases (version 9.3.x and higher).
yii\db\cubrid\Schema Schema is the class for retrieving metadata from a CUBRID database (version 9.3.x and higher).
yii\db\cubrid\conditions\LikeConditionBuilder
yii\db\mssql\ColumnSchema Class ColumnSchema for MSSQL database
yii\db\mssql\ColumnSchemaBuilder ColumnSchemaBuilder is the schema builder for MSSQL databases.
yii\db\mssql\DBLibPDO This is an extension of the default PDO class of DBLIB drivers.
yii\db\mssql\PDO This is an extension of the default PDO class of MSSQL and DBLIB drivers.
yii\db\mssql\QueryBuilder QueryBuilder is the query builder for MS SQL Server databases (version 2008 and above).
yii\db\mssql\Schema Schema is the class for retrieving metadata from MS SQL Server databases (version 2008 and above).
yii\db\mssql\SqlsrvPDO This is an extension of the default PDO class of SQLSRV driver.
yii\db\mssql\TableSchema TableSchema represents the metadata of a database table.
yii\db\mssql\conditions\InConditionBuilder
yii\db\mssql\conditions\LikeConditionBuilder
yii\db\mysql\ColumnSchema Class ColumnSchema for MySQL database
yii\db\mysql\ColumnSchemaBuilder ColumnSchemaBuilder is the schema builder for MySQL databases.
yii\db\mysql\JsonExpressionBuilder Class JsonExpressionBuilder builds yii\db\JsonExpression for MySQL DBMS.
yii\db\mysql\QueryBuilder QueryBuilder is the query builder for MySQL databases.
yii\db\mysql\Schema Schema is the class for retrieving metadata from a MySQL database (version 4.1.x and 5.x).
yii\db\oci\ColumnSchemaBuilder ColumnSchemaBuilder is the schema builder for Oracle databases.
yii\db\oci\Command Command represents an Oracle SQL statement to be executed against a database.
yii\db\oci\QueryBuilder QueryBuilder is the query builder for Oracle databases.
yii\db\oci\Schema Schema is the class for retrieving metadata from an Oracle database.
yii\db\oci\conditions\InConditionBuilder
yii\db\oci\conditions\LikeConditionBuilder
yii\db\pgsql\ArrayExpressionBuilder Class ArrayExpressionBuilder builds yii\db\ArrayExpression for PostgreSQL DBMS.
yii\db\pgsql\ArrayParser The class converts PostgreSQL array representation to PHP array
yii\db\pgsql\ColumnSchema Class ColumnSchema for PostgreSQL database.
yii\db\pgsql\JsonExpressionBuilder Class JsonExpressionBuilder builds yii\db\JsonExpression for PostgreSQL DBMS.
yii\db\pgsql\QueryBuilder QueryBuilder is the query builder for PostgreSQL databases.
yii\db\pgsql\Schema Schema is the class for retrieving metadata from a PostgreSQL database (version 9.x and above).
yii\db\sqlite\ColumnSchemaBuilder ColumnSchemaBuilder is the schema builder for Sqlite databases.
yii\db\sqlite\Command Command represents an SQLite's SQL statement to be executed against a database.
yii\db\sqlite\QueryBuilder QueryBuilder is the query builder for SQLite databases.
yii\db\sqlite\Schema Schema is the class for retrieving metadata from a SQLite (2/3) database.
yii\db\sqlite\SqlTokenizer SqlTokenizer splits SQLite query into individual SQL tokens.
yii\db\sqlite\conditions\InConditionBuilder
yii\db\sqlite\conditions\LikeConditionBuilder
yii\di\Container Container implements a dependency injection container.
yii\di\Instance Instance represents a reference to a named object in a dependency injection (DI) container or a service locator.
yii\di\NotInstantiableException NotInstantiableException represents an exception caused by incorrect dependency injection container configuration or usage.
yii\di\ServiceLocator ServiceLocator implements a service locator.
yii\filters\AccessControl AccessControl provides simple access control based on a set of rules.
yii\filters\AccessRule This class represents an access rule defined by the yii\filters\AccessControl action filter.
yii\filters\AjaxFilter AjaxFilter allow to limit access only for ajax requests.
yii\filters\ContentNegotiator ContentNegotiator supports response format negotiation and application language negotiation.
yii\filters\Cors Cors filter implements Cross Origin Resource Sharing.
yii\filters\HostControl HostControl provides simple control over requested host name.
yii\filters\HttpCache HttpCache implements client-side caching by utilizing the Last-Modified and ETag HTTP headers.
yii\filters\PageCache PageCache implements server-side caching of whole pages.
yii\filters\RateLimitInterface RateLimitInterface is the interface that may be implemented by an identity object to enforce rate limiting.
yii\filters\RateLimiter RateLimiter implements a rate limiting algorithm based on the leaky bucket algorithm.
yii\filters\VerbFilter VerbFilter is an action filter that filters by HTTP request methods.
yii\filters\auth\AuthInterface AuthInterface is the interface that should be implemented by auth method classes.
yii\filters\auth\AuthMethod AuthMethod is a base class implementing the yii\filters\auth\AuthInterface interface.
yii\filters\auth\CompositeAuth CompositeAuth is an action filter that supports multiple authentication methods at the same time.
yii\filters\auth\HttpBasicAuth HttpBasicAuth is an action filter that supports the HTTP Basic authentication method.
yii\filters\auth\HttpBearerAuth HttpBearerAuth is an action filter that supports the authentication method based on HTTP Bearer token.
yii\filters\auth\HttpHeaderAuth HttpHeaderAuth is an action filter that supports HTTP authentication through HTTP Headers.
yii\filters\auth\QueryParamAuth QueryParamAuth is an action filter that supports the authentication based on the access token passed through a query parameter.
yii\grid\ActionColumn ActionColumn is a column for the yii\grid\GridView widget that displays buttons for viewing and manipulating the items.
yii\grid\CheckboxColumn CheckboxColumn displays a column of checkboxes in a grid view.
yii\grid\Column Column is the base class of all yii\grid\GridView column classes.
yii\grid\DataColumn DataColumn is the default column type for the yii\grid\GridView widget.
yii\grid\GridView The GridView widget is used to display data in a grid.
yii\grid\GridViewAsset This asset bundle provides the javascript files for the yii\grid\GridView widget.
yii\grid\RadioButtonColumn RadioButtonColumn displays a column of radio buttons in a grid view.
yii\grid\SerialColumn SerialColumn displays a column of row numbers (1-based).
yii\helpers\ArrayHelper ArrayHelper provides additional array functionality that you can use in your application.
yii\helpers\BaseArrayHelper BaseArrayHelper provides concrete implementation for yii\helpers\ArrayHelper.
yii\helpers\BaseConsole BaseConsole provides concrete implementation for yii\helpers\Console.
yii\helpers\BaseFileHelper BaseFileHelper provides concrete implementation for yii\helpers\FileHelper.
yii\helpers\BaseFormatConverter BaseFormatConverter provides concrete implementation for yii\helpers\FormatConverter.
yii\helpers\BaseHtml BaseHtml provides concrete implementation for yii\helpers\Html.
yii\helpers\BaseHtmlPurifier BaseHtmlPurifier provides concrete implementation for yii\helpers\HtmlPurifier.
yii\helpers\BaseInflector BaseInflector provides concrete implementation for yii\helpers\Inflector.
yii\helpers\BaseIpHelper Class BaseIpHelper provides concrete implementation for yii\helpers\IpHelper
yii\helpers\BaseJson BaseJson provides concrete implementation for yii\helpers\Json.
yii\helpers\BaseMarkdown BaseMarkdown provides concrete implementation for yii\helpers\Markdown.
yii\helpers\BaseStringHelper BaseStringHelper provides concrete implementation for yii\helpers\StringHelper.
yii\helpers\BaseUrl BaseUrl provides concrete implementation for yii\helpers\Url.
yii\helpers\BaseVarDumper BaseVarDumper provides concrete implementation for yii\helpers\VarDumper.
yii\helpers\Console Console helper provides useful methods for command line related tasks such as getting input or formatting and coloring output.
yii\helpers\FileHelper File system helper.
yii\helpers\FormatConverter FormatConverter provides functionality to convert between different formatting pattern formats.
yii\helpers\Html Html provides a set of static methods for generating commonly used HTML tags.
yii\helpers\HtmlPurifier HtmlPurifier provides an ability to clean up HTML from any harmful code.
yii\helpers\Inflector Inflector pluralizes and singularizes English nouns. It also contains some other useful methods.
yii\helpers\IpHelper Class IpHelper provides a set of IP-related static methods.
yii\helpers\Json Json is a helper class providing JSON data encoding and decoding.
yii\helpers\Markdown Markdown provides an ability to transform markdown into HTML.
yii\helpers\ReplaceArrayValue Object that represents the replacement of array value while performing yii\helpers\ArrayHelper::merge().
yii\helpers\StringHelper StringHelper.
yii\helpers\UnsetArrayValue Object that represents the removal of array value while performing yii\helpers\ArrayHelper::merge().
yii\helpers\Url Url provides a set of static methods for managing URLs.
yii\helpers\VarDumper VarDumper is intended to replace the buggy PHP function var_dump and print_r.
yii\i18n\DbMessageSource DbMessageSource extends yii\i18n\MessageSource and represents a message source that stores translated messages in database.
yii\i18n\Formatter Formatter provides a set of commonly used data formatting methods.
yii\i18n\GettextFile GettextFile is the base class for representing a Gettext message file.
yii\i18n\GettextMessageSource GettextMessageSource represents a message source that is based on GNU Gettext.
yii\i18n\GettextMoFile GettextMoFile represents an MO Gettext message file.
yii\i18n\GettextPoFile GettextPoFile represents a PO Gettext message file.
yii\i18n\I18N I18N provides features related with internationalization (I18N) and localization (L10N).
yii\i18n\Locale Locale provides various locale information via convenient methods.
yii\i18n\MessageFormatter MessageFormatter allows formatting messages via ICU message format.
yii\i18n\MessageSource MessageSource is the base class for message translation repository classes.
yii\i18n\MissingTranslationEvent MissingTranslationEvent represents the parameter for the yii\i18n\MessageSource::EVENT_MISSING_TRANSLATION event.
yii\i18n\PhpMessageSource PhpMessageSource represents a message source that stores translated messages in PHP scripts.
yii\log\DbTarget DbTarget stores log messages in a database table.
yii\log\Dispatcher Dispatcher manages a set of log targets.
yii\log\EmailTarget EmailTarget sends selected log messages to the specified email addresses.
yii\log\FileTarget FileTarget records log messages in a file.
yii\log\LogRuntimeException LogRuntimeException represents an exception caused by problems with log delivery.
yii\log\Logger Logger records logged messages in memory and sends them to different targets if $dispatcher is set.
yii\log\SyslogTarget SyslogTarget writes log to syslog.
yii\log\Target Target is the base class for all log target classes.
yii\mail\BaseMailer BaseMailer serves as a base class that implements the basic functions required by yii\mail\MailerInterface.
yii\mail\BaseMessage BaseMessage serves as a base class that implements the send() method required by yii\mail\MessageInterface.
yii\mail\MailEvent MailEvent represents the event parameter used for events triggered by yii\mail\BaseMailer.
yii\mail\MailerInterface MailerInterface is the interface that should be implemented by mailer classes.
yii\mail\MessageInterface MessageInterface is the interface that should be implemented by mail message classes.
yii\mutex\DbMutex DbMutex is the base class for classes, which relies on database while implementing mutex "lock" mechanism.
yii\mutex\FileMutex FileMutex implements mutex "lock" mechanism via local file system files.
yii\mutex\Mutex The Mutex component allows mutual execution of concurrent processes in order to prevent "race conditions".
yii\mutex\MysqlMutex MysqlMutex implements mutex "lock" mechanism via MySQL locks.
yii\mutex\OracleMutex OracleMutex implements mutex "lock" mechanism via Oracle locks.
yii\mutex\PgsqlMutex PgsqlMutex implements mutex "lock" mechanism via PgSQL locks.
yii\mutex\RetryAcquireTrait Trait RetryAcquireTrait.
yii\rbac\Assignment Assignment represents an assignment of a role to a user.
yii\rbac\BaseManager BaseManager is a base class implementing yii\rbac\ManagerInterface for RBAC management.
yii\rbac\CheckAccessInterface For more details and usage information on CheckAccessInterface, see the guide article on security authorization.
yii\rbac\DbManager DbManager represents an authorization manager that stores authorization information in database.
yii\rbac\Item For more details and usage information on Item, see the guide article on security authorization.
yii\rbac\ManagerInterface For more details and usage information on ManagerInterface, see the guide article on security authorization.
yii\rbac\Permission For more details and usage information on Permission, see the guide article on security authorization.
yii\rbac\PhpManager PhpManager represents an authorization manager that stores authorization information in terms of a PHP script file.
yii\rbac\Role For more details and usage information on Role, see the guide article on security authorization.
yii\rbac\Rule Rule represents a business constraint that may be associated with a role, permission or assignment.
yii\rest\Action Action is the base class for action classes that implement RESTful API.
yii\rest\ActiveController ActiveController implements a common set of actions for supporting RESTful access to ActiveRecord.
yii\rest\Controller Controller is the base class for RESTful API controller classes.
yii\rest\CreateAction CreateAction implements the API endpoint for creating a new model from the given data.
yii\rest\DeleteAction DeleteAction implements the API endpoint for deleting a model.
yii\rest\IndexAction IndexAction implements the API endpoint for listing multiple models.
yii\rest\OptionsAction OptionsAction responds to the OPTIONS request by sending back an Allow header.
yii\rest\Serializer Serializer converts resource objects and collections into array representation.
yii\rest\UpdateAction UpdateAction implements the API endpoint for updating a model.
yii\rest\UrlRule UrlRule is provided to simplify the creation of URL rules for RESTful API support.
yii\rest\ViewAction ViewAction implements the API endpoint for returning the detailed information about a model.
yii\test\ActiveFixture ActiveFixture represents a fixture backed up by a ActiveRecord class or a database table.
yii\test\ArrayFixture ArrayFixture represents arbitrary fixture that can be loaded from PHP files.
yii\test\BaseActiveFixture BaseActiveFixture is the base class for fixture classes that support accessing fixture data as ActiveRecord objects.
yii\test\DbFixture DbFixture is the base class for DB-related fixtures.
yii\test\FileFixtureTrait FileFixtureTrait provides functionalities for loading data fixture from file.
yii\test\Fixture Fixture represents a fixed state of a test environment.
yii\test\FixtureTrait FixtureTrait provides functionalities for loading, unloading and accessing fixtures for a test case.
yii\test\InitDbFixture InitDbFixture represents the initial state needed for DB-related tests.
yii\validators\BooleanValidator BooleanValidator checks if the attribute value is a boolean value.
yii\validators\CompareValidator CompareValidator compares the specified attribute value with another value.
yii\validators\DateValidator DateValidator verifies if the attribute represents a date, time or datetime in a proper $format.
yii\validators\DefaultValueValidator DefaultValueValidator sets the attribute to be the specified default value.
yii\validators\EachValidator EachValidator validates an array by checking each of its elements against an embedded validation rule.
yii\validators\EmailValidator EmailValidator validates that the attribute value is a valid email address.
yii\validators\ExistValidator ExistValidator validates that the attribute value exists in a table.
yii\validators\FileValidator FileValidator verifies if an attribute is receiving a valid uploaded file.
yii\validators\FilterValidator FilterValidator converts the attribute value according to a filter.
yii\validators\ImageValidator ImageValidator verifies if an attribute is receiving a valid image.
yii\validators\InlineValidator InlineValidator represents a validator which is defined as a method in the object being validated.
yii\validators\IpValidator The validator checks if the attribute value is a valid IPv4/IPv6 address or subnet.
yii\validators\NumberValidator NumberValidator validates that the attribute value is a number.
yii\validators\PunycodeAsset This asset bundle provides the javascript files needed for the yii\validators\EmailValidators client validation.
yii\validators\RangeValidator RangeValidator validates that the attribute value is among a list of values.
yii\validators\RegularExpressionValidator RegularExpressionValidator validates that the attribute value matches the specified $pattern.
yii\validators\RequiredValidator RequiredValidator validates that the specified attribute does not have null or empty value.
yii\validators\SafeValidator SafeValidator serves as a dummy validator whose main purpose is to mark the attributes to be safe for massive assignment.
yii\validators\StringValidator StringValidator validates that the attribute value is of certain length.
yii\validators\TrimValidator This class converts the attribute value(s) to string(s) and strip characters.
yii\validators\UniqueValidator UniqueValidator validates that the attribute value is unique in the specified database table.
yii\validators\UrlValidator UrlValidator validates that the attribute value is a valid http or https URL.
yii\validators\ValidationAsset This asset bundle provides the javascript files for client validation.
yii\validators\Validator Validator is the base class for all validators.
yii\web\Application Application is the base class for all web application classes.
yii\web\AssetBundle AssetBundle represents a collection of asset files, such as CSS, JS, images.
yii\web\AssetConverter AssetConverter supports conversion of several popular formats into JS or CSS files.
yii\web\AssetConverterInterface The AssetConverterInterface must be implemented by asset converter classes.
yii\web\AssetManager AssetManager manages asset bundle configuration and loading.
yii\web\BadRequestHttpException BadRequestHttpException represents a "Bad Request" HTTP exception with status code 400.
yii\web\CacheSession CacheSession implements a session component using cache as storage medium.
yii\web\CompositeUrlRule CompositeUrlRule is the base class for URL rule classes that consist of multiple simpler rules.
yii\web\ConflictHttpException ConflictHttpException represents a "Conflict" HTTP exception with status code 409.
yii\web\Controller Controller is the base class of web controllers.
yii\web\Cookie Cookie represents information related with a cookie, such as $name, $value, $domain, etc.
yii\web\CookieCollection CookieCollection maintains the cookies available in the current request.
yii\web\DbSession DbSession extends yii\web\Session by using database as session data storage.
yii\web\ErrorAction ErrorAction displays application errors using a specified view.
yii\web\ErrorHandler ErrorHandler handles uncaught PHP errors and exceptions.
yii\web\ForbiddenHttpException ForbiddenHttpException represents a "Forbidden" HTTP exception with status code 403.
yii\web\GoneHttpException GoneHttpException represents a "Gone" HTTP exception with status code 410.
yii\web\GroupUrlRule GroupUrlRule represents a collection of URL rules sharing the same prefix in their patterns and routes.
yii\web\HeaderCollection HeaderCollection is used by yii\web\Response to maintain the currently registered HTTP headers.
yii\web\HeadersAlreadySentException HeadersAlreadySentException represents an exception caused by any headers that were already sent before web response was sent.
yii\web\HtmlResponseFormatter HtmlResponseFormatter formats the given data into an HTML response content.
yii\web\HttpException HttpException represents an exception caused by an improper request of the end-user.
yii\web\IdentityInterface IdentityInterface is the interface that should be implemented by a class providing identity information.
yii\web\JqueryAsset This asset bundle provides the jQuery JavaScript library.
yii\web\JsExpression JsExpression marks a string as a JavaScript expression.
yii\web\JsonParser Parses a raw HTTP request using yii\helpers\Json::decode().
yii\web\JsonResponseFormatter JsonResponseFormatter formats the given data into a JSON or JSONP response content.
yii\web\Link Link represents a link object as defined in JSON Hypermedia API Language.
yii\web\Linkable Linkable is the interface that should be implemented by classes that typically represent locatable resources.
yii\web\MethodNotAllowedHttpException MethodNotAllowedHttpException represents a "Method Not Allowed" HTTP exception with status code 405.
yii\web\MultiFieldSession MultiFieldSession is the base class for session storage implementations with multi-field data storage support.
yii\web\MultipartFormDataParser MultipartFormDataParser parses content encoded as 'multipart/form-data'.
yii\web\NotAcceptableHttpException NotAcceptableHttpException represents a "Not Acceptable" HTTP exception with status code 406.
yii\web\NotFoundHttpException NotFoundHttpException represents a "Not Found" HTTP exception with status code 404.
yii\web\RangeNotSatisfiableHttpException RangeNotSatisfiableHttpException represents an exception caused by an improper request of the end-user.
yii\web\Request The web Request class represents an HTTP request.
yii\web\RequestParserInterface Interface for classes that parse the raw request body into a parameters array.
yii\web\Response The web Response class represents an HTTP response.
yii\web\ResponseFormatterInterface ResponseFormatterInterface specifies the interface needed to format a response before it is sent out.
yii\web\ServerErrorHttpException ServerErrorHttpException represents an "Internal Server Error" HTTP exception with status code 500.
yii\web\Session Session provides session data management and the related configurations.
yii\web\SessionIterator SessionIterator implements an iterator for traversing session variables managed by yii\web\Session.
yii\web\TooManyRequestsHttpException TooManyRequestsHttpException represents a "Too Many Requests" HTTP exception with status code 429.
yii\web\UnauthorizedHttpException UnauthorizedHttpException represents an "Unauthorized" HTTP exception with status code 401.
yii\web\UnprocessableEntityHttpException UnprocessableEntityHttpException represents an "Unprocessable Entity" HTTP exception with status code 422.
yii\web\UnsupportedMediaTypeHttpException UnsupportedMediaTypeHttpException represents an "Unsupported Media Type" HTTP exception with status code 415.
yii\web\UploadedFile UploadedFile represents the information for an uploaded file.
yii\web\UrlManager UrlManager handles HTTP request parsing and creation of URLs based on a set of rules.
yii\web\UrlNormalizer UrlNormalizer normalizes URLs for yii\web\UrlManager and yii\web\UrlRule.
yii\web\UrlNormalizerRedirectException UrlNormalizerRedirectException represents an information for redirection which should be performed during the URL normalization.
yii\web\UrlRule UrlRule represents a rule used by yii\web\UrlManager for parsing and generating URLs.
yii\web\UrlRuleInterface UrlRuleInterface is the interface that should be implemented by URL rule classes.
yii\web\User User is the class for the user application component that manages the user authentication status.
yii\web\UserEvent This event class is used for Events triggered by the yii\web\User class.
yii\web\View View represents a view object in the MVC pattern.
yii\web\ViewAction ViewAction represents an action that displays a view according to a user-specified parameter.
yii\web\XmlResponseFormatter XmlResponseFormatter formats the given data into an XML response content.
yii\web\YiiAsset This asset bundle provides the base JavaScript files for the Yii Framework.
yii\widgets\ActiveField ActiveField represents a form input field within an yii\widgets\ActiveForm.
yii\widgets\ActiveForm ActiveForm is a widget that builds an interactive HTML form for one or multiple data models.
yii\widgets\ActiveFormAsset The asset bundle for the yii\widgets\ActiveForm widget.
yii\widgets\BaseListView BaseListView is a base class for widgets displaying data from data provider such as ListView and GridView.
yii\widgets\Block Block records all output between begin() and end() calls and stores it in yii\base\View::$blocks.
yii\widgets\Breadcrumbs Breadcrumbs displays a list of links indicating the position of the current page in the whole site hierarchy.
yii\widgets\ContentDecorator ContentDecorator records all output between begin() and end() calls, passes it to the given view file as $content and then echoes rendering result.
yii\widgets\DetailView DetailView displays the detail of a single data $model.
yii\widgets\FragmentCache FragmentCache is used by yii\base\View to provide caching of page fragments.
yii\widgets\InputWidget InputWidget is the base class for widgets that collect user inputs.
yii\widgets\LinkPager LinkPager displays a list of hyperlinks that lead to different pages of target.
yii\widgets\LinkSorter LinkSorter renders a list of sort links for the given sort definition.
yii\widgets\ListView The ListView widget is used to display data from data provider. Each data model is rendered using the view specified.
yii\widgets\MaskedInput MaskedInput generates a masked text input.
yii\widgets\MaskedInputAsset The asset bundle for the yii\widgets\MaskedInput widget.
yii\widgets\Menu Menu displays a multi-level menu using nested HTML lists.
yii\widgets\Pjax Pjax is a widget integrating the pjax jQuery plugin.
yii\widgets\PjaxAsset This asset bundle provides the javascript files required by yii\widgets\Pjax widget.
yii\widgets\Spaceless Spaceless widget removes whitespace characters between HTML tags. Whitespaces within HTML tags or in a plain text are always left untouched.