Yii Framework 2.0 API Documentation

Download as pdf or txt
Download as pdf or txt
You are on page 1of 25

Not namespaced classes

yii

yii\base

yii\behaviors

yii\caching

yii\captcha

yii\console

yii\console\controllers

yii\data

yii\db

yii\db\cubrid

yii\db\mssql

yii\db\mysql

yii\db\oci

yii\db\pgsql

yii\db\sqlite

yii\di

yii\filters

yii\filters\auth

yii\grid
yii\helpers

yii\i18n

yii\log

yii\mail

yii\mutex

yii\rbac

yii\rest

yii\test

yii\validators

yii\web

yii\widgets

Yii PHP Framework Version 2


1. Installation

This is the core framework code of Yii 2 (https://github.com/yiisoft/yii2#readme).

This repository is a read-only git subsplit of https://github.com/yiisoft/yii2 (https://github.com/yiisoft/yii2).


Please submit issue reports and pull requests to the main repository. For license information check the
LICENSE (LICENSE.md)-file.

Installation
The preferred way to install the Yii framework is through composer (http://getcomposer.org/download/).

Either run

composer global require "fxp/composer-asset-plugin:^1.2.0"


composer require yiisoft/yii2

or add
"yiisoft/yii2": "~2.0.0",

to the require section of your composer.json.

Class Reference
Class Description

Yii (yii.html) Yii is a helper class serving common framework


functionalities.

yii\BaseYii (yii-baseyii.html) BaseYii is the core helper class for the Yii framework.

yii\base\Action (yii-base-action.html) Action is the base class for all controller action classes.

yii\base\ActionEvent (yii-base- ActionEvent represents the event parameter used for an


actionevent.html) action event.

yii\base\ActionFilter (yii-base-actionfilter.html) ActionFilter is the base class for action filters.

yii\base\Application (yii-base-application.html) Application is the base class for all application classes.

yii\base\ArrayAccessTrait (yii-base- ArrayAccessTrait provides the implementation for


arrayaccesstrait.html) IteratorAggregate
(http://www.php.net/class.iteratoraggregate), ArrayAccess
(http://www.php.net/class.arrayaccess) and Countable
(http://www.php.net/class.countable).

yii\base\Arrayable (yii-base-arrayable.html) Arrayable is the interface that should be implemented by


classes who want to support customizable representation
of their instances.

yii\base\ArrayableTrait (yii-base- ArrayableTrait provides a common implementation of the


arrayabletrait.html) yii\base\Arrayable (yii-base-arrayable.html) interface.

yii\base\Behavior (yii-base-behavior.html) Behavior is the base class for all behavior classes.

yii\base\BootstrapInterface (yii-base- BootstrapInterface is the interface that should be


bootstrapinterface.html) implemented by classes who want to participate in the
application bootstrap process.

yii\base\Component (yii-base- Component is the base class that implements the


component.html) property, event and behavior features.

yii\base\Configurable (yii-base- Configurable is the interface that should be implemented


configurable.html) by classes who support configuring its properties through
the last parameter to its constructor.

yii\base\Controller (yii-base-controller.html) Controller is the base class for classes containing


controller logic.

yii\base\DynamicModel (yii-base- DynamicModel is a model class primarily used to support


dynamicmodel.html) ad hoc data validation.

yii\base\ErrorException (yii-base- ErrorException represents a PHP error.


errorexception.html)

yii\base\ErrorHandler (yii-base- ErrorHandler handles uncaught PHP errors and


errorhandler.html) exceptions.

yii\base\Event (yii-base-event.html) Event is the base class for all event classes.

yii\base\Exception (yii-base-exception.html) Exception represents a generic exception for all purposes.

yii\base\ExitException (yii-base- ExitException represents a normal termination of an


exitexception.html) application.

yii\base\InlineAction (yii-base- InlineAction represents an action that is defined as a


inlineaction.html) controller method.

yii\base\InvalidCallException (yii-base- InvalidCallException represents an exception caused by


invalidcallexception.html) calling a method in a wrong way.

yii\base\InvalidConfigException (yii-base- InvalidConfigException represents an exception caused by


invalidconfigexception.html) incorrect object configuration.

yii\base\InvalidParamException (yii-base- InvalidParamException represents an exception caused by


invalidparamexception.html) invalid parameters passed to a method.

yii\base\InvalidRouteException (yii-base- InvalidRouteException represents an exception caused by


invalidrouteexception.html) an invalid route.

yii\base\InvalidValueException (yii-base- InvalidValueException represents an exception caused by


invalidvalueexception.html) a function returning a value of unexpected type.

yii\base\Model (yii-base-model.html) Model is the base class for data models.

yii\base\ModelEvent (yii-base- ModelEvent represents the parameter needed by


modelevent.html) yii\base\Model (yii-base-model.html) events.

yii\base\Module (yii-base-module.html) Module is the base class for module and application
classes.
yii\base\NotSupportedException (yii-base- NotSupportedException represents an exception caused
notsupportedexception.html) by accessing features that are not supported.

yii\base\Object (yii-base-object.html) Object is the base class that implements the property
feature.

yii\base\Request (yii-base-request.html) Request represents a request that is handled by an


yii\base\Application (yii-base-application.html).

yii\base\Response (yii-base-response.html) Response represents the response of an


yii\base\Application (yii-base-application.html) to a
yii\base\Request (yii-base-request.html).

yii\base\Security (yii-base-security.html) Security provides a set of methods to handle common


security-related tasks.

yii\base\Theme (yii-base-theme.html) Theme represents an application theme.

yii\base\UnknownClassException (yii-base- UnknownClassException represents an exception caused


unknownclassexception.html) by using an unknown class.

yii\base\UnknownMethodException (yii-base- UnknownMethodException represents an exception


unknownmethodexception.html) caused by accessing an unknown object method.

yii\base\UnknownPropertyException (yii- UnknownPropertyException represents an exception


base-unknownpropertyexception.html) caused by accessing unknown object properties.

yii\base\UserException (yii-base- UserException is the base class for exceptions that are
userexception.html) meant to be shown to end users.

yii\base\View (yii-base-view.html) View represents a view object in the MVC pattern.

yii\base\ViewContextInterface (yii-base- ViewContextInterface is the interface that should


viewcontextinterface.html) implemented by classes who want to support relative view
names.

yii\base\ViewEvent (yii-base-viewevent.html) ViewEvent represents events triggered by the


yii\base\View (yii-base-view.html) component.

yii\base\ViewNotFoundException (yii-base- ViewNotFoundException represents an exception caused


viewnotfoundexception.html) by view file not found.

yii\base\ViewRenderer (yii-base- ViewRenderer is the base class for view renderer classes.
viewrenderer.html)

yii\base\Widget (yii-base-widget.html) Widget is the base class for widgets.

yii\behaviors\AttributeBehavior (yii-behaviors- AttributeBehavior automatically assigns a specified value


attributebehavior.html) to one or multiple attributes of an ActiveRecord object
when certain events happen.

yii\behaviors\AttributeTypecastBehavior (yii- AttributeTypecastBehavior provides an ability of automatic


behaviors-attributetypecastbehavior.html) model attribute typecasting.

yii\behaviors\BlameableBehavior (yii- BlameableBehavior automatically fills the specified


behaviors-blameablebehavior.html) attributes with the current user ID.

yii\behaviors\SluggableBehavior (yii- SluggableBehavior automatically fills the specified


behaviors-sluggablebehavior.html) attribute with a value that can be used a slug in a URL.

yii\behaviors\TimestampBehavior (yii- TimestampBehavior automatically fills the specified


behaviors-timestampbehavior.html) attributes with the current timestamp.

yii\caching\ApcCache (yii-caching- ApcCache provides APC caching in terms of an


apccache.html) application component.

yii\caching\ArrayCache (yii-caching- ArrayCache provides caching for the current request only
arraycache.html) by storing the values in an array.

yii\caching\Cache (yii-caching-cache.html) Cache is the base class for cache classes supporting
different cache storage implementations.

yii\caching\ChainedDependency (yii-caching- ChainedDependency represents a dependency which is


chaineddependency.html) composed of a list of other dependencies.

yii\caching\DbCache (yii-caching- DbCache implements a cache application component by


dbcache.html) storing cached data in a database.

yii\caching\DbDependency (yii-caching- DbDependency represents a dependency based on the


dbdependency.html) query result of a SQL statement.

yii\caching\Dependency (yii-caching- Dependency is the base class for cache dependency


dependency.html) classes.

yii\caching\DummyCache (yii-caching- DummyCache is a placeholder cache component.


dummycache.html)

yii\caching\ExpressionDependency (yii- ExpressionDependency represents a dependency based


caching-expressiondependency.html) on the result of a PHP expression.

yii\caching\FileCache (yii-caching- FileCache implements a cache component using files.


filecache.html)

yii\caching\FileDependency (yii-caching- FileDependency represents a dependency based on a


filedependency.html) file's last modification time.
yii\caching\MemCache (yii-caching- MemCache implements a cache application component
memcache.html) based on memcache
(http://pecl.php.net/package/memcache) and memcached
(http://pecl.php.net/package/memcached).

yii\caching\MemCacheServer (yii-caching- MemCacheServer represents the configuration data for a


memcacheserver.html) single memcache or memcached server.

yii\caching\TagDependency (yii-caching- TagDependency associates a cached data item with one


tagdependency.html) or multiple $tags (yii-caching-tagdependency.html#$tags-
detail).

yii\caching\WinCache (yii-caching- WinCache provides Windows Cache caching in terms of


wincache.html) an application component.

yii\caching\XCache (yii-caching-xcache.html) XCache provides XCache caching in terms of an


application component.

yii\caching\ZendDataCache (yii-caching- ZendDataCache provides Zend data caching in terms of


zenddatacache.html) an application component.

yii\captcha\Captcha (yii-captcha- Captcha renders a CAPTCHA image and an input field that
captcha.html) takes user-entered verification code.

yii\captcha\CaptchaAction (yii-captcha- CaptchaAction renders a CAPTCHA image.


captchaaction.html)

yii\captcha\CaptchaAsset (yii-captcha- This asset bundle provides the javascript files needed for
captchaasset.html) the yii\captcha\Captcha (yii-captcha-captcha.html) widget.

yii\captcha\CaptchaValidator (yii-captcha- CaptchaValidator validates that the attribute value is the


captchavalidator.html) same as the verification code displayed in the CAPTCHA.

yii\console\Application (yii-console- Application represents a console application.


application.html)

yii\console\Controller (yii-console- Controller is the base class of console command classes.


controller.html)

yii\console\ErrorHandler (yii-console- ErrorHandler handles uncaught PHP errors and


errorhandler.html) exceptions.

yii\console\Exception (yii-console- Exception represents an exception caused by incorrect


exception.html) usage of a console command.

yii\console\Markdown (yii-console- A Markdown parser that enhances markdown for reading


markdown.html) in console environments.
yii\console\Request (yii-console-request.html) The console Request represents the environment
information for a console application.

yii\console\Response (yii-console- The console Response represents the result of a console


response.html) application.

yii\console\controllers\AssetController (yii- Allows you to combine and compress your JavaScript and
console-controllers-assetcontroller.html) CSS files.

yii\console\controllers\BaseMigrateController BaseMigrateController is base class for migrate


(yii-console-controllers- controllers.
basemigratecontroller.html)

yii\console\controllers\CacheController (yii- Allows you to flush cache.


console-controllers-cachecontroller.html)

yii\console\controllers\FixtureController (yii- Manages fixture data loading and unloading.


console-controllers-fixturecontroller.html)

yii\console\controllers\HelpController (yii- Provides help information about console commands.


console-controllers-helpcontroller.html)

yii\console\controllers\MessageController (yii- Extracts messages to be translated from source files.


console-controllers-messagecontroller.html)

yii\console\controllers\MigrateController (yii- Manages application migrations.


console-controllers-migratecontroller.html)

yii\console\controllers\ServeController (yii- Runs PHP built-in web server


console-controllers-servecontroller.html)

yii\data\ActiveDataProvider (yii-data- ActiveDataProvider implements a data provider based on


activedataprovider.html) yii\db\Query (yii-db-query.html) and yii\db\ActiveQuery (yii-
db-activequery.html).

yii\data\ArrayDataProvider (yii-data- ArrayDataProvider implements a data provider based on a


arraydataprovider.html) data array.

yii\data\BaseDataProvider (yii-data- BaseDataProvider provides a base class that implements


basedataprovider.html) the yii\data\DataProviderInterface (yii-data-
dataproviderinterface.html).

yii\data\DataProviderInterface (yii-data- DataProviderInterface is the interface that must be


dataproviderinterface.html) implemented by data provider classes.

yii\data\Pagination (yii-data-pagination.html) Pagination represents information relevant to pagination of


data items.
yii\data\Sort (yii-data-sort.html) Sort represents information relevant to sorting.

yii\data\SqlDataProvider (yii-data- SqlDataProvider implements a data provider based on a


sqldataprovider.html) plain SQL statement.

yii\db\ActiveQuery (yii-db-activequery.html) ActiveQuery represents a DB query associated with an


Active Record class.

yii\db\ActiveQueryInterface (yii-db- ActiveQueryInterface defines the common interface to be


activequeryinterface.html) implemented by active record query classes.

yii\db\ActiveQueryTrait (yii-db- ActiveQueryTrait implements the common methods and


activequerytrait.html) properties for active record query classes.

yii\db\ActiveRecord (yii-db-activerecord.html) ActiveRecord is the base class for classes representing


relational data in terms of objects.

yii\db\ActiveRecordInterface (yii-db- ActiveRecordInterface


activerecordinterface.html)

yii\db\ActiveRelationTrait (yii-db- ActiveRelationTrait implements the common methods and


activerelationtrait.html) properties for active record relational queries.

yii\db\AfterSaveEvent (yii-db- AfterSaveEvent represents the information available in


aftersaveevent.html) yii\db\ActiveRecord::EVENT_AFTER_INSERT (yii-db-
baseactiverecord.html#EVENT_AFTER_INSERT-detail) and
yii\db\ActiveRecord::EVENT_AFTER_UPDATE (yii-db-
baseactiverecord.html#EVENT_AFTER_UPDATE-detail).

yii\db\BaseActiveRecord (yii-db- ActiveRecord is the base class for classes representing


baseactiverecord.html) relational data in terms of objects.

yii\db\BatchQueryResult (yii-db- BatchQueryResult represents a batch query from which


batchqueryresult.html) you can retrieve data in batches.

yii\db\ColumnSchema (yii-db- ColumnSchema class describes the metadata of a column


columnschema.html) in a database table.

yii\db\ColumnSchemaBuilder (yii-db- ColumnSchemaBuilder helps to define database schema


columnschemabuilder.html) types using a PHP interface.

yii\db\Command (yii-db-command.html) Command represents a SQL statement to be executed


against a database.

yii\db\Connection (yii-db-connection.html) Connection represents a connection to a database via


PDO (http://php.net/manual/en/book.pdo.php).
yii\db\DataReader (yii-db-datareader.html) DataReader represents a forward-only stream of rows from
a query result set.

yii\db\Exception (yii-db-exception.html) Exception represents an exception that is caused by some


DB-related operations.

yii\db\Expression (yii-db-expression.html) Expression represents a DB expression that does not need


escaping or quoting.

yii\db\IntegrityException (yii-db- Exception represents an exception that is caused by


integrityexception.html) violation of DB constraints.

yii\db\Migration (yii-db-migration.html) Migration is the base class for representing a database


migration.

yii\db\MigrationInterface (yii-db- The MigrationInterface defines the minimum set of


migrationinterface.html) methods to be implemented by a database migration.

yii\db\Query (yii-db-query.html) Query represents a SELECT SQL statement in a way that


is independent of DBMS.

yii\db\QueryBuilder (yii-db-querybuilder.html) QueryBuilder builds a SELECT SQL statement based on


the specification given as a yii\db\Query (yii-db-query.html)
object.

yii\db\QueryInterface (yii-db- The QueryInterface defines the minimum set of methods


queryinterface.html) to be implemented by a database query.

yii\db\QueryTrait (yii-db-querytrait.html) The BaseQuery trait represents the minimum method set
of a database Query.

yii\db\Schema (yii-db-schema.html) Schema is the base class for concrete DBMS-specific


schema classes.

yii\db\SchemaBuilderTrait (yii-db- SchemaBuilderTrait contains shortcut methods to create


schemabuildertrait.html) instances of yii\db\ColumnSchemaBuilder (yii-db-
columnschemabuilder.html).

yii\db\StaleObjectException (yii-db-
staleobjectexception.html)

yii\db\TableSchema (yii-db-tableschema.html) TableSchema represents the metadata of a database


table.

yii\db\Transaction (yii-db-transaction.html) Transaction represents a DB transaction.

yii\db\cubrid\ColumnSchemaBuilder (yii-db- ColumnSchemaBuilder is the schema builder for Cubrid


cubrid-columnschemabuilder.html) databases.
yii\db\cubrid\QueryBuilder (yii-db-cubrid- QueryBuilder is the query builder for CUBRID databases
querybuilder.html) (version 9.3.x and higher).

yii\db\cubrid\Schema (yii-db-cubrid- Schema is the class for retrieving metadata from a


schema.html) CUBRID database (version 9.3.x and higher).

yii\db\mssql\PDO (yii-db-mssql-pdo.html) This is an extension of the default PDO class of MSSQL


and DBLIB drivers.

yii\db\mssql\QueryBuilder (yii-db-mssql- QueryBuilder is the query builder for MS SQL Server


querybuilder.html) databases (version 2008 and above).

yii\db\mssql\Schema (yii-db-mssql- Schema is the class for retrieving metadata from a MS


schema.html) SQL Server databases (version 2008 and above).

yii\db\mssql\SqlsrvPDO (yii-db-mssql- This is an extension of the default PDO class of SQLSRV


sqlsrvpdo.html) driver.

yii\db\mssql\TableSchema (yii-db-mssql- TableSchema represents the metadata of a database


tableschema.html) table.

yii\db\mysql\ColumnSchemaBuilder (yii-db- ColumnSchemaBuilder is the schema builder for MySQL


mysql-columnschemabuilder.html) databases.

yii\db\mysql\QueryBuilder (yii-db-mysql- QueryBuilder is the query builder for MySQL databases.


querybuilder.html)

yii\db\mysql\Schema (yii-db-mysql- Schema is the class for retrieving metadata from a MySQL
schema.html) database (version 4.1.x and 5.x).

yii\db\oci\ColumnSchemaBuilder (yii-db-oci- ColumnSchemaBuilder is the schema builder for Oracle


columnschemabuilder.html) databases.

yii\db\oci\QueryBuilder (yii-db-oci- QueryBuilder is the query builder for Oracle databases.


querybuilder.html)

yii\db\oci\Schema (yii-db-oci-schema.html) Schema is the class for retrieving metadata from an Oracle
database

yii\db\pgsql\QueryBuilder (yii-db-pgsql- QueryBuilder is the query builder for PostgreSQL


querybuilder.html) databases.

yii\db\pgsql\Schema (yii-db-pgsql- Schema is the class for retrieving metadata from a


schema.html) PostgreSQL database (version 9.x and above).

yii\db\sqlite\ColumnSchemaBuilder (yii-db- ColumnSchemaBuilder is the schema builder for Sqlite


sqlite-columnschemabuilder.html) databases.

yii\db\sqlite\QueryBuilder (yii-db-sqlite- QueryBuilder is the query builder for SQLite databases.


querybuilder.html)

yii\db\sqlite\Schema (yii-db-sqlite- Schema is the class for retrieving metadata from a SQLite
schema.html) (2/3) database.

yii\di\Container (yii-di-container.html) Container implements a dependency injection


(http://en.wikipedia.org/wiki/Dependency_injection)
container.

yii\di\Instance (yii-di-instance.html) Instance represents a reference to a named object in a


dependency injection (DI) container or a service locator.

yii\di\NotInstantiableException (yii-di- NotInstantiableException represents an exception caused


notinstantiableexception.html) by incorrect dependency injection container configuration
or usage.

yii\di\ServiceLocator (yii-di- ServiceLocator implements a service locator


servicelocator.html) (http://en.wikipedia.org/wiki/Service_locator_pattern).

yii\filters\AccessControl (yii-filters- AccessControl provides simple access control based on a


accesscontrol.html) set of rules.

yii\filters\AccessRule (yii-filters- This class represents an access rule defined by the


accessrule.html) yii\filters\AccessControl (yii-filters-accesscontrol.html)
action filter

yii\filters\ContentNegotiator (yii-filters- ContentNegotiator supports response format negotiation


contentnegotiator.html) and application language negotiation.

yii\filters\Cors (yii-filters-cors.html) Cors filter implements Cross Origin Resource Sharing


(http://en.wikipedia.org/wiki/Cross-
origin_resource_sharing).

yii\filters\HttpCache (yii-filters-httpcache.html) HttpCache implements client-side caching by utilizing the


Last-Modified and ETag HTTP headers.

yii\filters\PageCache (yii-filters- PageCache implements server-side caching of whole


pagecache.html) pages.

yii\filters\RateLimitInterface (yii-filters- RateLimitInterface is the interface that may be


ratelimitinterface.html) implemented by an identity object to enforce rate limiting.

yii\filters\RateLimiter (yii-filters- RateLimiter implements a rate limiting algorithm based on


ratelimiter.html) the leaky bucket algorithm
(http://en.wikipedia.org/wiki/Leaky_bucket).
yii\filters\VerbFilter (yii-filters-verbfilter.html) VerbFilter is an action filter that filters by HTTP request
methods.

yii\filters\auth\AuthInterface (yii-filters-auth- AuthInterface is the interface that should be implemented


authinterface.html) by auth method classes.

yii\filters\auth\AuthMethod (yii-filters-auth- AuthMethod is a base class implementing the


authmethod.html) yii\filters\auth\AuthInterface (yii-filters-auth-
authinterface.html) interface.

yii\filters\auth\CompositeAuth (yii-filters-auth- CompositeAuth is an action filter that supports multiple


compositeauth.html) authentication methods at the same time.

yii\filters\auth\HttpBasicAuth (yii-filters-auth- HttpBasicAuth is an action filter that supports the HTTP


httpbasicauth.html) Basic authentication method.

yii\filters\auth\HttpBearerAuth (yii-filters-auth- HttpBearerAuth is an action filter that supports the


httpbearerauth.html) authentication method based on HTTP Bearer token.

yii\filters\auth\QueryParamAuth (yii-filters- QueryParamAuth is an action filter that supports the


auth-queryparamauth.html) authentication based on the access token passed through
a query parameter.

yii\grid\ActionColumn (yii-grid- ActionColumn is a column for the yii\grid\GridView (yii-


actioncolumn.html) grid-gridview.html) widget that displays buttons for
viewing and manipulating the items.

yii\grid\CheckboxColumn (yii-grid- CheckboxColumn displays a column of checkboxes in a


checkboxcolumn.html) grid view.

yii\grid\Column (yii-grid-column.html) Column is the base class of all yii\grid\GridView (yii-grid-


gridview.html) column classes.

yii\grid\DataColumn (yii-grid- DataColumn is the default column type for the


datacolumn.html) yii\grid\GridView (yii-grid-gridview.html) widget.

yii\grid\GridView (yii-grid-gridview.html) The GridView widget is used to display data in a grid.

yii\grid\GridViewAsset (yii-grid- This asset bundle provides the javascript files for the
gridviewasset.html) yii\grid\GridView (yii-grid-gridview.html) widget.

yii\grid\SerialColumn (yii-grid- SerialColumn displays a column of row numbers (1-


serialcolumn.html) based).

yii\helpers\ArrayHelper (yii-helpers- ArrayHelper provides additional array functionality that you


arrayhelper.html) can use in your application.
yii\helpers\BaseArrayHelper (yii-helpers- BaseArrayHelper provides concrete implementation for
basearrayhelper.html) yii\helpers\ArrayHelper (yii-helpers-arrayhelper.html).

yii\helpers\BaseConsole (yii-helpers- BaseConsole provides concrete implementation for


baseconsole.html) yii\helpers\Console (yii-helpers-console.html).

yii\helpers\BaseFileHelper (yii-helpers- BaseFileHelper provides concrete implementation for


basefilehelper.html) yii\helpers\FileHelper (yii-helpers-filehelper.html).

yii\helpers\BaseFormatConverter (yii-helpers- BaseFormatConverter provides concrete implementation


baseformatconverter.html) for yii\helpers\FormatConverter (yii-helpers-
formatconverter.html).

yii\helpers\BaseHtml (yii-helpers- BaseHtml provides concrete implementation for


basehtml.html) yii\helpers\Html (yii-helpers-html.html).

yii\helpers\BaseHtmlPurifier (yii-helpers- BaseHtmlPurifier provides concrete implementation for


basehtmlpurifier.html) yii\helpers\HtmlPurifier (yii-helpers-htmlpurifier.html).

yii\helpers\BaseInflector (yii-helpers- BaseInflector provides concrete implementation for


baseinflector.html) yii\helpers\Inflector (yii-helpers-inflector.html).

yii\helpers\BaseJson (yii-helpers- BaseJson provides concrete implementation for


basejson.html) yii\helpers\Json (yii-helpers-json.html).

yii\helpers\BaseMarkdown (yii-helpers- BaseMarkdown provides concrete implementation for


basemarkdown.html) yii\helpers\Markdown (yii-helpers-markdown.html).

yii\helpers\BaseStringHelper (yii-helpers- BaseStringHelper provides concrete implementation for


basestringhelper.html) yii\helpers\StringHelper (yii-helpers-stringhelper.html).

yii\helpers\BaseUrl (yii-helpers-baseurl.html) BaseUrl provides concrete implementation for


yii\helpers\Url (yii-helpers-url.html).

yii\helpers\BaseVarDumper (yii-helpers- BaseVarDumper provides concrete implementation for


basevardumper.html) yii\helpers\VarDumper (yii-helpers-vardumper.html).

yii\helpers\Console (yii-helpers-console.html) Console helper provides useful methods for command line
related tasks such as getting input or formatting and
coloring output.

yii\helpers\FileHelper (yii-helpers- File system helper


filehelper.html)

yii\helpers\FormatConverter (yii-helpers- FormatConverter provides functionality to convert


formatconverter.html) between different formatting pattern formats.
yii\helpers\Html (yii-helpers-html.html) Html provides a set of static methods for generating
commonly used HTML tags.

yii\helpers\HtmlPurifier (yii-helpers- HtmlPurifier provides an ability to clean up HTML from any


htmlpurifier.html) harmful code.

yii\helpers\Inflector (yii-helpers-inflector.html) Inflector pluralizes and singularizes English nouns. It also


contains some other useful methods.

yii\helpers\Json (yii-helpers-json.html) Json is a helper class providing JSON data encoding and
decoding.

yii\helpers\Markdown (yii-helpers- Markdown provides an ability to transform markdown into


markdown.html) HTML.

yii\helpers\ReplaceArrayValue (yii-helpers- Object that represents the replacement of array value


replacearrayvalue.html) while performing yii\helpers\ArrayHelper::merge() (yii-
helpers-basearrayhelper.html#merge()-detail).

yii\helpers\StringHelper (yii-helpers- StringHelper


stringhelper.html)

yii\helpers\UnsetArrayValue (yii-helpers- Object that represents the removal of array value while
unsetarrayvalue.html) performing yii\helpers\ArrayHelper::merge() (yii-helpers-
basearrayhelper.html#merge()-detail).

yii\helpers\Url (yii-helpers-url.html) Url provides a set of static methods for managing URLs.

yii\helpers\VarDumper (yii-helpers- VarDumper is intended to replace the buggy PHP function


vardumper.html) var_dump and print_r.

yii\i18n\DbMessageSource (yii-i18n- DbMessageSource extends yii\i18n\MessageSource (yii-


dbmessagesource.html) i18n-messagesource.html) and represents a message
source that stores translated messages in database.

yii\i18n\Formatter (yii-i18n-formatter.html) Formatter provides a set of commonly used data


formatting methods.

yii\i18n\GettextFile (yii-i18n-gettextfile.html) GettextFile is the base class for representing a Gettext


message file.

yii\i18n\GettextMessageSource (yii-i18n- GettextMessageSource represents a message source that


gettextmessagesource.html) is based on GNU Gettext.

yii\i18n\GettextMoFile (yii-i18n- GettextMoFile represents an MO Gettext message file.


gettextmofile.html)
yii\i18n\GettextPoFile (yii-i18n- GettextPoFile represents a PO Gettext message file.
gettextpofile.html)

yii\i18n\I18N (yii-i18n-i18n.html) I18N provides features related with internationalization


(I18N) and localization (L10N).

yii\i18n\MessageFormatter (yii-i18n- MessageFormatter allows formatting messages via ICU


messageformatter.html) message format (http://userguide.icu-
project.org/formatparse/messages)

yii\i18n\MessageSource (yii-i18n- MessageSource is the base class for message translation


messagesource.html) repository classes.

yii\i18n\MissingTranslationEvent (yii-i18n- MissingTranslationEvent represents the parameter for the


missingtranslationevent.html) yii\i18n\MessageSource::EVENT_MISSING_TRANSLATION
(yii-i18n-
messagesource.html#EVENT_MISSING_TRANSLATION-
detail) event.

yii\i18n\PhpMessageSource (yii-i18n- PhpMessageSource represents a message source that


phpmessagesource.html) stores translated messages in PHP scripts.

yii\log\DbTarget (yii-log-dbtarget.html) DbTarget stores log messages in a database table.

yii\log\Dispatcher (yii-log-dispatcher.html) Dispatcher manages a set of log targets (yii-log-


target.html).

yii\log\EmailTarget (yii-log-emailtarget.html) EmailTarget sends selected log messages to the specified


email addresses.

yii\log\FileTarget (yii-log-filetarget.html) FileTarget records log messages in a file.

yii\log\Logger (yii-log-logger.html) Logger records logged messages in memory and sends


them to different targets if $dispatcher (yii-log-
logger.html#$dispatcher-detail) is set.

yii\log\SyslogTarget (yii-log-syslogtarget.html) SyslogTarget writes log to syslog.

yii\log\Target (yii-log-target.html) Target is the base class for all log target classes.

yii\mail\BaseMailer (yii-mail-basemailer.html) BaseMailer serves as a base class that implements the


basic functions required by yii\mail\MailerInterface (yii-
mail-mailerinterface.html).

yii\mail\BaseMessage (yii-mail- BaseMessage serves as a base class that implements the


basemessage.html) send() (yii-mail-basemessage.html#send()-detail) method
required by yii\mail\MessageInterface (yii-mail-
messageinterface.html).
yii\mail\MailEvent (yii-mail-mailevent.html) MailEvent represents the event parameter used for events
triggered by yii\mail\BaseMailer (yii-mail-basemailer.html).

yii\mail\MailerInterface (yii-mail- MailerInterface is the interface that should be implemented


mailerinterface.html) by mailer classes.

yii\mail\MessageInterface (yii-mail- MessageInterface is the interface that should be


messageinterface.html) implemented by mail message classes.

yii\mutex\DbMutex (yii-mutex-dbmutex.html) DbMutex is the base class for classes, which relies on
database while implementing mutex "lock" mechanism.

yii\mutex\FileMutex (yii-mutex-filemutex.html) FileMutex implements mutex "lock" mechanism via local


file system files.

yii\mutex\Mutex (yii-mutex-mutex.html) The Mutex component allows mutual execution of


concurrent processes in order to prevent "race
conditions".

yii\mutex\MysqlMutex (yii-mutex- MysqlMutex implements mutex "lock" mechanism via


mysqlmutex.html) MySQL locks.

yii\mutex\OracleMutex (yii-mutex- OracleMutex implements mutex "lock" mechanism via


oraclemutex.html) Oracle locks.

yii\mutex\PgsqlMutex (yii-mutex- PgsqlMutex implements mutex "lock" mechanism via


pgsqlmutex.html) PgSQL locks.

yii\rbac\Assignment (yii-rbac- Assignment represents an assignment of a role to a user.


assignment.html)

yii\rbac\BaseManager (yii-rbac- BaseManager is a base class implementing


basemanager.html) yii\rbac\ManagerInterface (yii-rbac-managerinterface.html)
for RBAC management.

yii\rbac\CheckAccessInterface (yii-rbac-
checkaccessinterface.html)

yii\rbac\DbManager (yii-rbac-dbmanager.html) DbManager represents an authorization manager that


stores authorization information in database.

yii\rbac\Item (yii-rbac-item.html)

yii\rbac\ManagerInterface (yii-rbac-
managerinterface.html)

yii\rbac\Permission (yii-rbac-permission.html)
yii\rbac\PhpManager (yii-rbac- PhpManager represents an authorization manager that
phpmanager.html) stores authorization information in terms of a PHP script
file.

yii\rbac\Role (yii-rbac-role.html)

yii\rbac\Rule (yii-rbac-rule.html) Rule represents a business constraint that may be


associated with a role, permission or assignment.

yii\rest\Action (yii-rest-action.html) Action is the base class for action classes that implement
RESTful API.

yii\rest\ActiveController (yii-rest- ActiveController implements a common set of actions for


activecontroller.html) supporting RESTful access to ActiveRecord.

yii\rest\Controller (yii-rest-controller.html) Controller is the base class for RESTful API controller
classes.

yii\rest\CreateAction (yii-rest- CreateAction implements the API endpoint for creating a


createaction.html) new model from the given data.

yii\rest\DeleteAction (yii-rest- DeleteAction implements the API endpoint for deleting a


deleteaction.html) model.

yii\rest\IndexAction (yii-rest-indexaction.html)

yii\rest\OptionsAction (yii-rest- OptionsAction responds to the OPTIONS request by


optionsaction.html) sending back an Allow header.

yii\rest\Serializer (yii-rest-serializer.html) Serializer converts resource objects and collections into


array representation.

yii\rest\UpdateAction (yii-rest- UpdateAction implements the API endpoint for updating a


updateaction.html) model.

yii\rest\UrlRule (yii-rest-urlrule.html) UrlRule is provided to simplify the creation of URL rules for
RESTful API support.

yii\rest\ViewAction (yii-rest-viewaction.html) ViewAction implements the API endpoint for returning the
detailed information about a model.

yii\test\ActiveFixture (yii-test- ActiveFixture represents a fixture backed up by a


activefixture.html) ActiveRecord class (yii-test-
baseactivefixture.html#$modelClass-detail) or a database
table (yii-test-activefixture.html#$tableName-detail).
yii\test\ArrayFixture (yii-test-arrayfixture.html) ArrayFixture represents arbitrary fixture that can be loaded
from PHP files.

yii\test\BaseActiveFixture (yii-test- BaseActiveFixture is the base class for fixture classes that
baseactivefixture.html) support accessing fixture data as ActiveRecord objects.

yii\test\DbFixture (yii-test-dbfixture.html) DbFixture is the base class for DB-related fixtures.

yii\test\Fixture (yii-test-fixture.html) Fixture represents a fixed state of a test environment.

yii\test\FixtureTrait (yii-test-fixturetrait.html) FixtureTrait provides functionalities for loading, unloading


and accessing fixtures for a test case.

yii\test\InitDbFixture (yii-test-initdbfixture.html) InitDbFixture represents the initial state needed for DB-
related tests.

yii\validators\BooleanValidator (yii-validators- BooleanValidator checks if the attribute value is a boolean


booleanvalidator.html) value.

yii\validators\CompareValidator (yii-validators- CompareValidator compares the specified attribute value


comparevalidator.html) with another value.

yii\validators\DateValidator (yii-validators- DateValidator verifies if the attribute represents a date,


datevalidator.html) time or datetime in a proper $format (yii-validators-
datevalidator.html#$format-detail).

yii\validators\DefaultValueValidator (yii- DefaultValueValidator sets the attribute to be the specified


validators-defaultvaluevalidator.html) default value.

yii\validators\EachValidator (yii-validators- EachValidator validates an array by checking each of its


eachvalidator.html) elements against an embedded validation rule.

yii\validators\EmailValidator (yii-validators- EmailValidator validates that the attribute value is a valid


emailvalidator.html) email address.

yii\validators\ExistValidator (yii-validators- ExistValidator validates that the attribute value exists in a


existvalidator.html) table.

yii\validators\FileValidator (yii-validators- FileValidator verifies if an attribute is receiving a valid


filevalidator.html) uploaded file.

yii\validators\FilterValidator (yii-validators- FilterValidator converts the attribute value according to a


filtervalidator.html) filter.

yii\validators\ImageValidator (yii-validators- ImageValidator verifies if an attribute is receiving a valid


imagevalidator.html) image.

yii\validators\InlineValidator (yii-validators- InlineValidator represents a validator which is defined as a


inlinevalidator.html) method in the object being validated.

yii\validators\IpValidator (yii-validators- The validator checks if the attribute value is a valid


ipvalidator.html) IPv4/IPv6 address or subnet.

yii\validators\NumberValidator (yii-validators- NumberValidator validates that the attribute value is a


numbervalidator.html) number.

yii\validators\PunycodeAsset (yii-validators- This asset bundle provides the javascript files needed for
punycodeasset.html) the yii\validators\EmailValidator (yii-validators-
emailvalidator.html)s client validation.

yii\validators\RangeValidator (yii-validators- RangeValidator validates that the attribute value is among


rangevalidator.html) a list of values.

yii\validators\RegularExpressionValidator (yii- RegularExpressionValidator validates that the attribute


validators-regularexpressionvalidator.html) value matches the specified $pattern (yii-validators-
regularexpressionvalidator.html#$pattern-detail).

yii\validators\RequiredValidator (yii-validators- RequiredValidator validates that the specified attribute


requiredvalidator.html) does not have null or empty value.

yii\validators\SafeValidator (yii-validators- SafeValidator serves as a dummy validator whose main


safevalidator.html) purpose is to mark the attributes to be safe for massive
assignment.

yii\validators\StringValidator (yii-validators- StringValidator validates that the attribute value is of


stringvalidator.html) certain length.

yii\validators\UniqueValidator (yii-validators- UniqueValidator validates that the attribute value is unique


uniquevalidator.html) in the specified database table.

yii\validators\UrlValidator (yii-validators- UrlValidator validates that the attribute value is a valid http
urlvalidator.html) or https URL.

yii\validators\ValidationAsset (yii-validators- This asset bundle provides the javascript files for client
validationasset.html) validation.

yii\validators\Validator (yii-validators- Validator is the base class for all validators.


validator.html)

yii\web\Application (yii-web-application.html) Application is the base class for all web application
classes.

yii\web\AssetBundle (yii-web- AssetBundle represents a collection of asset files, such as


assetbundle.html) CSS, JS, images.
yii\web\AssetConverter (yii-web- AssetConverter supports conversion of several popular
assetconverter.html) script formats into JS or CSS scripts.

yii\web\AssetConverterInterface (yii-web- The AssetConverterInterface must be implemented by


assetconverterinterface.html) asset converter classes.

yii\web\AssetManager (yii-web- AssetManager manages asset bundle configuration and


assetmanager.html) loading.

yii\web\BadRequestHttpException (yii-web- BadRequestHttpException represents a "Bad Request"


badrequesthttpexception.html) HTTP exception with status code 400.

yii\web\CacheSession (yii-web- CacheSession implements a session component using


cachesession.html) cache as storage medium.

yii\web\CompositeUrlRule (yii-web- CompositeUrlRule is the base class for URL rule classes
compositeurlrule.html) that consist of multiple simpler rules.

yii\web\ConflictHttpException (yii-web- ConflictHttpException represents a "Conflict" HTTP


conflicthttpexception.html) exception with status code 409

yii\web\Controller (yii-web-controller.html) Controller is the base class of web controllers.

yii\web\Cookie (yii-web-cookie.html) Cookie represents information related with a cookie, such


as $name (yii-web-cookie.html#$name-detail), $value (yii-
web-cookie.html#$value-detail), $domain (yii-web-
cookie.html#$domain-detail), etc.

yii\web\CookieCollection (yii-web- CookieCollection maintains the cookies available in the


cookiecollection.html) current request.

yii\web\DbSession (yii-web-dbsession.html) DbSession extends yii\web\Session (yii-web-session.html)


by using database as session data storage.

yii\web\ErrorAction (yii-web-erroraction.html) ErrorAction displays application errors using a specified


view.

yii\web\ErrorHandler (yii-web- ErrorHandler handles uncaught PHP errors and


errorhandler.html) exceptions.

yii\web\ForbiddenHttpException (yii-web- ForbiddenHttpException represents a "Forbidden" HTTP


forbiddenhttpexception.html) exception with status code 403.

yii\web\GoneHttpException (yii-web- GoneHttpException represents a "Gone" HTTP exception


gonehttpexception.html) with status code 410

yii\web\GroupUrlRule (yii-web- GroupUrlRule represents a collection of URL rules sharing


groupurlrule.html) the same prefix in their patterns and routes.
yii\web\HeaderCollection (yii-web- HeaderCollection is used by yii\web\Response (yii-web-
headercollection.html) response.html) to maintain the currently registered HTTP
headers.

yii\web\HtmlResponseFormatter (yii-web- HtmlResponseFormatter formats the given data into an


htmlresponseformatter.html) HTML response content.

yii\web\HttpException (yii-web- HttpException represents an exception caused by an


httpexception.html) improper request of the end-user.

yii\web\IdentityInterface (yii-web- IdentityInterface is the interface that should be


identityinterface.html) implemented by a class providing identity information.

yii\web\JqueryAsset (yii-web- This asset bundle provides the jquery javascript library
jqueryasset.html) (http://jquery.com/)

yii\web\JsExpression (yii-web- JsExpression marks a string as a JavaScript expression.


jsexpression.html)

yii\web\JsonParser (yii-web-jsonparser.html) Parses a raw HTTP request using


yii\helpers\Json::decode() (yii-helpers-
basejson.html#decode()-detail)

yii\web\JsonResponseFormatter (yii-web- JsonResponseFormatter formats the given data into a


jsonresponseformatter.html) JSON or JSONP response content.

yii\web\Link (yii-web-link.html) Link represents a link object as defined in JSON


Hypermedia API Language
(https://tools.ietf.org/html/draft-kelly-json-hal-03).

yii\web\Linkable (yii-web-linkable.html) Linkable is the interface that should be implemented by


classes that typically represent locatable resources.

yii\web\MethodNotAllowedHttpException (yii- MethodNotAllowedHttpException represents a "Method


web-methodnotallowedhttpexception.html) Not Allowed" HTTP exception with status code 405.

yii\web\MultiFieldSession (yii-web- MultiFieldSession is the base class for session storage


multifieldsession.html) implementations with multi-field data storage support.

yii\web\MultipartFormDataParser (yii-web- MultipartFormDataParser parses content encoded as


multipartformdataparser.html) 'multipart/form-data'.

yii\web\NotAcceptableHttpException (yii- NotAcceptableHttpException represents a "Not


web-notacceptablehttpexception.html) Acceptable" HTTP exception with status code 406

yii\web\NotFoundHttpException (yii-web- NotFoundHttpException represents a "Not Found" HTTP


notfoundhttpexception.html) exception with status code 404.

yii\web\Request (yii-web-request.html) The web Request class represents an HTTP request

yii\web\RequestParserInterface (yii-web- Interface for classes that parse the raw request body into
requestparserinterface.html) a parameters array.

yii\web\Response (yii-web-response.html) The web Response class represents an HTTP response

yii\web\ResponseFormatterInterface (yii-web- ResponseFormatterInterface specifies the interface


responseformatterinterface.html) needed to format a response before it is sent out.

yii\web\ServerErrorHttpException (yii-web- ServerErrorHttpException represents an "Internal Server


servererrorhttpexception.html) Error" HTTP exception with status code 500.

yii\web\Session (yii-web-session.html) Session provides session data management and the


related configurations.

yii\web\SessionIterator (yii-web- SessionIterator implements an iterator


sessioniterator.html) (http://www.php.net/class.iterator) for traversing session
variables managed by yii\web\Session (yii-web-
session.html).

yii\web\TooManyRequestsHttpException (yii- TooManyRequestsHttpException represents a "Too Many


web-toomanyrequestshttpexception.html) Requests" HTTP exception with status code 429

yii\web\UnauthorizedHttpException (yii-web- UnauthorizedHttpException represents an "Unauthorized"


unauthorizedhttpexception.html) HTTP exception with status code 401

yii\web\UnprocessableEntityHttpException UnprocessableEntityHttpException represents an


(yii-web- "Unprocessable Entity" HTTP exception with status code
unprocessableentityhttpexception.html) 422.

yii\web\UnsupportedMediaTypeHttpException UnsupportedMediaTypeHttpException represents an


(yii-web- "Unsupported Media Type" HTTP exception with status
unsupportedmediatypehttpexception.html) code 415

yii\web\UploadedFile (yii-web- UploadedFile represents the information for an uploaded


uploadedfile.html) file.

yii\web\UrlManager (yii-web-urlmanager.html) UrlManager handles HTTP request parsing and creation of


URLs based on a set of rules.

yii\web\UrlNormalizer (yii-web- UrlNormalizer normalizes URLs for yii\web\UrlManager (yii-


urlnormalizer.html) web-urlmanager.html) and yii\web\UrlRule (yii-web-
urlrule.html).

yii\web\UrlNormalizerRedirectException (yii- UrlNormalizerRedirectException represents an information


web-urlnormalizerredirectexception.html) for redirection which should be performed during the URL
normalization.

yii\web\UrlRule (yii-web-urlrule.html) UrlRule represents a rule used by yii\web\UrlManager (yii-


web-urlmanager.html) for parsing and generating URLs.

yii\web\UrlRuleInterface (yii-web- UrlRuleInterface is the interface that should be


urlruleinterface.html) implemented by URL rule classes.

yii\web\User (yii-web-user.html) User is the class for the user application component that
manages the user authentication status.

yii\web\UserEvent (yii-web-userevent.html) This event class is used for Events triggered by the
yii\web\User (yii-web-user.html) class.

yii\web\View (yii-web-view.html) View represents a view object in the MVC pattern.

yii\web\ViewAction (yii-web-viewaction.html) ViewAction represents an action that displays a view


according to a user-specified parameter.

yii\web\XmlResponseFormatter (yii-web- XmlResponseFormatter formats the given data into an


xmlresponseformatter.html) XML response content.

yii\web\YiiAsset (yii-web-yiiasset.html) This asset bundle provides the base javascript files for the
Yii Framework.

yii\widgets\ActiveField (yii-widgets- ActiveField represents a form input field within an


activefield.html) yii\widgets\ActiveForm (yii-widgets-activeform.html).

yii\widgets\ActiveForm (yii-widgets- ActiveForm is a widget that builds an interactive HTML


activeform.html) form for one or multiple data models.

yii\widgets\ActiveFormAsset (yii-widgets-
activeformasset.html)

yii\widgets\BaseListView (yii-widgets- BaseListView is a base class for widgets displaying data


baselistview.html) from data provider such as ListView and GridView.

yii\widgets\Block (yii-widgets-block.html) Block records all output between begin() (yii-base-


widget.html#begin()-detail) and end() (yii-base-
widget.html#end()-detail) calls and stores it in
yii\base\View::$blocks (yii-base-view.html#$blocks-detail).

yii\widgets\Breadcrumbs (yii-widgets- Breadcrumbs displays a list of links indicating the position


breadcrumbs.html) of the current page in the whole site hierarchy.

yii\widgets\ContentDecorator (yii-widgets- ContentDecorator records all output between begin() (yii-


contentdecorator.html) base-widget.html#begin()-detail) and end() (yii-base-
widget.html#end()-detail) calls, passes it to the given view
file as $content and then echoes rendering result.

yii\widgets\DetailView (yii-widgets- DetailView displays the detail of a single data $model (yii-
detailview.html) widgets-detailview.html#$model-detail).

yii\widgets\FragmentCache (yii-widgets- FragmentCache is used by yii\base\View (yii-base-


fragmentcache.html) view.html) to provide caching of page fragments.

yii\widgets\InputWidget (yii-widgets- InputWidget is the base class for widgets that collect user
inputwidget.html) inputs.

yii\widgets\LinkPager (yii-widgets- LinkPager displays a list of hyperlinks that lead to different


linkpager.html) pages of target.

yii\widgets\LinkSorter (yii-widgets- LinkSorter renders a list of sort links for the given sort
linksorter.html) definition.

yii\widgets\ListView (yii-widgets-listview.html) The ListView widget is used to display data from data
provider. Each data model is rendered using the view
specified.

yii\widgets\MaskedInput (yii-widgets- MaskedInput generates a masked text input.


maskedinput.html)

yii\widgets\MaskedInputAsset (yii-widgets- The asset bundle for the yii\widgets\MaskedInput (yii-


maskedinputasset.html) widgets-maskedinput.html) widget.

yii\widgets\Menu (yii-widgets-menu.html) Menu displays a multi-level menu using nested HTML lists.

yii\widgets\Pjax (yii-widgets-pjax.html) Pjax is a widget integrating the pjax


(https://github.com/yiisoft/jquery-pjax) jQuery plugin.

yii\widgets\PjaxAsset (yii-widgets- This asset bundle provides the javascript files required by
pjaxasset.html) yii\widgets\Pjax (yii-widgets-pjax.html) widget.

yii\widgets\Spaceless (yii-widgets- Spaceless widget removes whitespace characters


spaceless.html) between HTML tags. Whitespaces within HTML tags or in
a plain text are always left untouched.

Powered by Yii Framework (http://www.yiiframework.com/) Page generated on Sat, 10 Sep 2016 12:46:12 +0000

You might also like