Yii Framework 2.0 API Documentation
Yii Framework 2.0 API Documentation
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
Installation
The preferred way to install the Yii framework is through composer (http://getcomposer.org/download/).
Either run
or add
"yiisoft/yii2": "~2.0.0",
Class Reference
Class Description
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\Application (yii-base-application.html) Application is the base class for all application classes.
yii\base\Behavior (yii-base-behavior.html) Behavior is the base class for all behavior classes.
yii\base\Event (yii-base-event.html) Event is the base class for all event classes.
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\UserException (yii-base- UserException is the base class for exceptions that are
userexception.html) meant to be shown to end users.
yii\base\ViewRenderer (yii-base- ViewRenderer is the base class for view renderer classes.
viewrenderer.html)
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\captcha\Captcha (yii-captcha- Captcha renders a CAPTCHA image and an input field that
captcha.html) takes user-entered verification code.
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\console\controllers\AssetController (yii- Allows you to combine and compress your JavaScript and
console-controllers-assetcontroller.html) CSS files.
yii\db\QueryTrait (yii-db-querytrait.html) The BaseQuery trait represents the minimum method set
of a database Query.
yii\db\StaleObjectException (yii-db-
staleobjectexception.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\Schema (yii-db-oci-schema.html) Schema is the class for retrieving metadata from an Oracle
database
yii\db\sqlite\Schema (yii-db-sqlite- Schema is the class for retrieving metadata from a SQLite
schema.html) (2/3) database.
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\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\Json (yii-helpers-json.html) Json is a helper class providing JSON data encoding and
decoding.
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\log\Target (yii-log-target.html) Target is the base class for all log target 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\rbac\CheckAccessInterface (yii-rbac-
checkaccessinterface.html)
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\rest\Action (yii-rest-action.html) Action is the base class for action classes that implement
RESTful API.
yii\rest\Controller (yii-rest-controller.html) Controller is the base class for RESTful API controller
classes.
yii\rest\IndexAction (yii-rest-indexaction.html)
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\BaseActiveFixture (yii-test- BaseActiveFixture is the base class for fixture classes that
baseactivefixture.html) support accessing fixture data as ActiveRecord objects.
yii\test\InitDbFixture (yii-test-initdbfixture.html) InitDbFixture represents the initial state needed for DB-
related tests.
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\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\web\Application (yii-web-application.html) Application is the base class for all web application
classes.
yii\web\CompositeUrlRule (yii-web- CompositeUrlRule is the base class for URL rule classes
compositeurlrule.html) that consist of multiple simpler rules.
yii\web\JqueryAsset (yii-web- This asset bundle provides the jquery javascript library
jqueryasset.html) (http://jquery.com/)
yii\web\RequestParserInterface (yii-web- Interface for classes that parse the raw request body into
requestparserinterface.html) a parameters array.
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\YiiAsset (yii-web-yiiasset.html) This asset bundle provides the base javascript files for the
Yii Framework.
yii\widgets\ActiveFormAsset (yii-widgets-
activeformasset.html)
yii\widgets\DetailView (yii-widgets- DetailView displays the detail of a single data $model (yii-
detailview.html) widgets-detailview.html#$model-detail).
yii\widgets\InputWidget (yii-widgets- InputWidget is the base class for widgets that collect user
inputwidget.html) inputs.
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\Menu (yii-widgets-menu.html) Menu displays a multi-level menu using nested HTML lists.
yii\widgets\PjaxAsset (yii-widgets- This asset bundle provides the javascript files required by
pjaxasset.html) yii\widgets\Pjax (yii-widgets-pjax.html) widget.
Powered by Yii Framework (http://www.yiiframework.com/) Page generated on Sat, 10 Sep 2016 12:46:12 +0000