Browse Source

Fixes #5385: links created from classes to corresponding guide articles (#12920)

tags/2.0.11
Boudewijn Vahrmeijer 8 years ago committed by Alexander Makarov
parent
commit
32f4dc8997
  1. 2
      framework/base/Action.php
  2. 2
      framework/base/ActionFilter.php
  3. 2
      framework/base/Application.php
  4. 2
      framework/base/Behavior.php
  5. 2
      framework/base/BootstrapInterface.php
  6. 2
      framework/base/Component.php
  7. 2
      framework/base/Configurable.php
  8. 2
      framework/base/Controller.php
  9. 2
      framework/base/ErrorException.php
  10. 2
      framework/base/ErrorHandler.php
  11. 2
      framework/base/Event.php
  12. 2
      framework/base/Exception.php
  13. 2
      framework/base/InlineAction.php
  14. 2
      framework/base/Model.php
  15. 2
      framework/base/Module.php
  16. 2
      framework/base/Request.php
  17. 2
      framework/base/Response.php
  18. 2
      framework/base/Security.php
  19. 2
      framework/base/Theme.php
  20. 2
      framework/base/View.php
  21. 2
      framework/base/Widget.php
  22. 2
      framework/caching/ApcCache.php
  23. 2
      framework/caching/ArrayCache.php
  24. 2
      framework/caching/Cache.php
  25. 2
      framework/caching/ChainedDependency.php
  26. 2
      framework/caching/DbCache.php
  27. 2
      framework/caching/DbDependency.php
  28. 2
      framework/caching/Dependency.php
  29. 2
      framework/caching/DummyCache.php
  30. 2
      framework/caching/ExpressionDependency.php
  31. 2
      framework/caching/FileCache.php
  32. 2
      framework/caching/FileDependency.php
  33. 2
      framework/caching/MemCache.php
  34. 2
      framework/caching/MemCacheServer.php
  35. 2
      framework/caching/TagDependency.php
  36. 2
      framework/caching/WinCache.php
  37. 2
      framework/caching/XCache.php
  38. 2
      framework/caching/ZendDataCache.php
  39. 2
      framework/data/ActiveDataProvider.php
  40. 2
      framework/data/ArrayDataProvider.php
  41. 2
      framework/data/BaseDataProvider.php
  42. 2
      framework/data/DataProviderInterface.php
  43. 2
      framework/data/Pagination.php
  44. 2
      framework/data/Sort.php
  45. 2
      framework/data/SqlDataProvider.php
  46. 2
      framework/db/Migration.php
  47. 2
      framework/db/QueryBuilder.php
  48. 2
      framework/di/Container.php
  49. 2
      framework/di/ServiceLocator.php
  50. 2
      framework/grid/ActionColumn.php
  51. 2
      framework/grid/CheckboxColumn.php
  52. 2
      framework/grid/Column.php
  53. 2
      framework/grid/DataColumn.php
  54. 2
      framework/grid/GridView.php
  55. 2
      framework/grid/SerialColumn.php
  56. 2
      framework/helpers/ArrayHelper.php
  57. 2
      framework/helpers/Html.php
  58. 2
      framework/helpers/Url.php
  59. 2
      framework/log/Logger.php
  60. 2
      framework/log/Target.php
  61. 2
      framework/mail/BaseMailer.php
  62. 2
      framework/rbac/Assignment.php
  63. 2
      framework/rbac/BaseManager.php
  64. 2
      framework/rbac/CheckAccessInterface.php
  65. 2
      framework/rbac/DbManager.php
  66. 2
      framework/rbac/Item.php
  67. 2
      framework/rbac/ManagerInterface.php
  68. 2
      framework/rbac/Permission.php
  69. 2
      framework/rbac/PhpManager.php
  70. 3
      framework/rbac/Role.php
  71. 2
      framework/rbac/Rule.php
  72. 2
      framework/rest/Action.php
  73. 2
      framework/rest/ActiveController.php
  74. 2
      framework/rest/Controller.php
  75. 2
      framework/rest/CreateAction.php
  76. 2
      framework/rest/DeleteAction.php
  77. 4
      framework/rest/IndexAction.php
  78. 2
      framework/rest/OptionsAction.php
  79. 2
      framework/rest/UpdateAction.php
  80. 2
      framework/rest/UrlRule.php
  81. 2
      framework/rest/ViewAction.php
  82. 2
      framework/test/ActiveFixture.php
  83. 2
      framework/test/ArrayFixture.php
  84. 2
      framework/test/BaseActiveFixture.php
  85. 2
      framework/test/DbFixture.php
  86. 2
      framework/test/Fixture.php
  87. 2
      framework/test/FixtureTrait.php
  88. 2
      framework/test/InitDbFixture.php
  89. 2
      framework/validators/Validator.php
  90. 2
      framework/web/Application.php
  91. 2
      framework/web/AssetBundle.php
  92. 2
      framework/web/AssetManager.php
  93. 2
      framework/web/Controller.php
  94. 2
      framework/web/Cookie.php
  95. 2
      framework/web/CookieCollection.php
  96. 2
      framework/web/ErrorHandler.php
  97. 2
      framework/web/Request.php
  98. 2
      framework/web/Response.php
  99. 2
      framework/web/Session.php
  100. 2
      framework/web/UploadedFile.php
  101. Some files were not shown because too many files have changed in this diff Show More

2
framework/base/Action.php

@ -28,6 +28,8 @@ use Yii;
* And the parameters provided for the action are: `['id' => 1]`.
* Then the `run()` method will be invoked as `run(1)` automatically.
*
* For more details and usage information on Action, see the [guide article on actions](guide:structure-controllers).
*
* @property string $uniqueId The unique ID of this action among the whole application. This property is
* read-only.
*

2
framework/base/ActionFilter.php

@ -15,6 +15,8 @@ namespace yii\base;
*
* Check implementation of [[\yii\filters\AccessControl]], [[\yii\filters\PageCache]] and [[\yii\filters\HttpCache]] as examples on how to use it.
*
* For more details and usage information on ActionFilter, see the [guide article on filters](guide:structure-filters).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/base/Application.php

@ -12,6 +12,8 @@ use Yii;
/**
* Application is the base class for all application classes.
*
* For more details and usage information on Application, see the [guide article on applications](guide:structure-applications).
*
* @property \yii\web\AssetManager $assetManager The asset manager application component. This property is
* read-only.
* @property \yii\rbac\ManagerInterface $authManager The auth manager application component. Null is returned

2
framework/base/Behavior.php

@ -15,6 +15,8 @@ namespace yii\base;
* and make them directly accessible via the component. It can also respond to the events triggered in the component
* and thus intercept the normal code execution.
*
* For more details and usage information on Behavior, see the [guide article on behaviors](guide:concept-behaviors).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/base/BootstrapInterface.php

@ -47,6 +47,8 @@ namespace yii\base;
*
* As you can see, you can register a bootstrapping class in terms of either a class name or a configuration class.
*
* For more details and usage information on BootstrapInterface, see the [guide article on bootstrapping applications](guide:structure-applications).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/base/Component.php

@ -90,6 +90,8 @@ use Yii;
* where `as tree` stands for attaching a behavior named `tree`, and the array will be passed to [[\Yii::createObject()]]
* to create the behavior object.
*
* For more details and usage information on Component, see the [guide article on components](guide:concept-components).
*
* @property Behavior[] $behaviors List of behaviors attached to this component. This property is read-only.
*
* @author Qiang Xue <qiang.xue@gmail.com>

2
framework/base/Configurable.php

@ -23,6 +23,8 @@ namespace yii\base;
* This interface is mainly used by [[\yii\di\Container]] so that it can pass object configuration as the
* last parameter to the implementing class' constructor.
*
* For more details and usage information on Configurable, see the [guide article on configurations](guide:concept-configurations).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0.3
*/

2
framework/base/Controller.php

@ -12,6 +12,8 @@ use Yii;
/**
* Controller is the base class for classes containing controller logic.
*
* For more details and usage information on Controller, see the [guide article on controllers](guide:structure-controllers).
*
* @property Module[] $modules All ancestor modules that this controller is located within. This property is
* read-only.
* @property string $route The route (module ID, controller ID and action ID) of the current request. This

2
framework/base/ErrorException.php

@ -12,6 +12,8 @@ use Yii;
/**
* ErrorException represents a PHP error.
*
* For more details and usage information on ErrorException, see the [guide article on handling errors](guide:runtime-handling-errors).
*
* @author Alexander Makarov <sam@rmcreative.ru>
* @since 2.0
*/

2
framework/base/ErrorHandler.php

@ -17,6 +17,8 @@ use yii\web\HttpException;
* ErrorHandler is configured as an application component in [[\yii\base\Application]] by default.
* You can access that instance via `Yii::$app->errorHandler`.
*
* For more details and usage information on ErrorHandler, see the [guide article on handling errors](guide:runtime-handling-errors).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Alexander Makarov <sam@rmcreative.ru>
* @author Carsten Brandt <mail@cebe.cc>

2
framework/base/Event.php

@ -19,6 +19,8 @@ namespace yii\base;
* Additionally, when attaching an event handler, extra data may be passed
* and be available via the [[data]] property when the event handler is invoked.
*
* For more details and usage information on Event, see the [guide article on events](guide:concept-events).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/base/Exception.php

@ -10,6 +10,8 @@ namespace yii\base;
/**
* Exception represents a generic exception for all purposes.
*
* For more details and usage information on Exception, see the [guide article on handling errors](guide:runtime-handling-errors).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/base/InlineAction.php

@ -15,6 +15,8 @@ use Yii;
* The name of the controller method is available via [[actionMethod]] which
* is set by the [[controller]] who creates this action.
*
* For more details and usage information on InlineAction, see the [guide article on actions](guide:structure-controllers).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/base/Model.php

@ -35,6 +35,8 @@ use yii\validators\Validator;
*
* You may directly use Model to store model data, or extend it with customization.
*
* For more details and usage information on Model, see the [guide article on models](guide:structure-models).
*
* @property \yii\validators\Validator[] $activeValidators The validators applicable to the current
* [[scenario]]. This property is read-only.
* @property array $attributes Attribute values (name => value).

2
framework/base/Module.php

@ -21,6 +21,8 @@ use yii\di\ServiceLocator;
* [[components|Components]] may be registered with the module so that they are globally
* accessible within the module.
*
* For more details and usage information on Module, see the [guide article on modules](guide:structure-modules).
*
* @property array $aliases List of path aliases to be defined. The array keys are alias names (must start
* with `@`) and the array values are the corresponding paths or aliases. See [[setAliases()]] for an example.
* This property is write-only.

2
framework/base/Request.php

@ -12,6 +12,8 @@ use Yii;
/**
* Request represents a request that is handled by an [[Application]].
*
* For more details and usage information on Request, see the [guide article on requests](guide:runtime-requests).
*
* @property boolean $isConsoleRequest The value indicating whether the current request is made via console.
* @property string $scriptFile Entry script file path (processed w/ realpath()).
*

2
framework/base/Response.php

@ -10,6 +10,8 @@ namespace yii\base;
/**
* Response represents the response of an [[Application]] to a [[Request]].
*
* For more details and usage information on Response, see the [guide article on responses](guide:runtime-responses).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/base/Security.php

@ -23,6 +23,8 @@ use Yii;
* > Note: this class requires 'OpenSSL' PHP extension for random key/string generation on Windows and
* for encryption/decryption on all platforms. For the highest security level PHP version >= 5.5.0 is recommended.
*
* For more details and usage information on Security, see the [guide article on security](guide:security-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Tom Worster <fsb@thefsb.org>
* @author Klimov Paul <klimov.paul@gmail.com>

2
framework/base/Theme.php

@ -61,6 +61,8 @@ use yii\helpers\FileHelper;
* that contains the entry script of the application. If your theme is designed to handle modules,
* you may configure the [[pathMap]] property like described above.
*
* For more details and usage information on Theme, see the [guide article on theming](guide:output-theming).
*
* @property string $basePath The root path of this theme. All resources of this theme are located under this
* directory.
* @property string $baseUrl The base URL (without ending slash) for this theme. All resources of this theme

2
framework/base/View.php

@ -18,6 +18,8 @@ use yii\widgets\FragmentCache;
*
* View provides a set of methods (e.g. [[render()]]) for rendering purpose.
*
* For more details and usage information on View, see the [guide article on views](guide:structure-views).
*
* @property string|boolean $viewFile The view file currently being rendered. False if no view file is being
* rendered. This property is read-only.
*

2
framework/base/Widget.php

@ -13,6 +13,8 @@ use ReflectionClass;
/**
* Widget is the base class for widgets.
*
* For more details and usage information on Widget, see the [guide article on widgets](guide:structure-widgets).
*
* @property string $id ID of the widget.
* @property \yii\web\View $view The view object that can be used to render views or view files. Note that the
* type of this property differs in getter and setter. See [[getView()]] and [[setView()]] for details.

2
framework/caching/ApcCache.php

@ -18,6 +18,8 @@ use yii\base\InvalidConfigException;
*
* See [[Cache]] for common cache operations that ApcCache supports.
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/caching/ArrayCache.php

@ -15,6 +15,8 @@ namespace yii\caching;
* Unlike the [[Cache]], ArrayCache allows the expire parameter of [[set]], [[add]], [[multiSet]] and [[multiAdd]] to
* be a floating point number, so you may specify the time in milliseconds (e.g. 0.1 will be 100 milliseconds).
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Carsten Brandt <mail@cebe.cc>
* @since 2.0
*/

2
framework/caching/Cache.php

@ -45,6 +45,8 @@ use yii\helpers\StringHelper;
* - [[deleteValue()]]: delete the value with the specified key from cache
* - [[flushValues()]]: delete all values from cache
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/caching/ChainedDependency.php

@ -14,6 +14,8 @@ namespace yii\caching;
* considered changed; When [[dependOnAll]] is false, if one of the dependencies has NOT changed,
* this dependency is considered NOT changed.
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/caching/DbCache.php

@ -31,6 +31,8 @@ use yii\di\Instance;
* ]
* ```
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/caching/DbDependency.php

@ -18,6 +18,8 @@ use yii\di\Instance;
* If the query result changes, the dependency is considered as changed.
* The query is specified via the [[sql]] property.
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/caching/Dependency.php

@ -13,6 +13,8 @@ namespace yii\caching;
* Child classes should override its [[generateDependencyData()]] for generating
* the actual dependency data.
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/caching/DummyCache.php

@ -15,6 +15,8 @@ namespace yii\caching;
* By replacing DummyCache with some other cache component, one can quickly switch from
* non-caching mode to caching mode.
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/caching/ExpressionDependency.php

@ -17,6 +17,8 @@ namespace yii\caching;
* A PHP expression can be any PHP code that has a value. To learn more about what an expression is,
* please refer to the [php manual](http://www.php.net/manual/en/language.expressions.php).
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/caching/FileCache.php

@ -19,6 +19,8 @@ use yii\helpers\FileHelper;
*
* Please refer to [[Cache]] for common cache operations that are supported by FileCache.
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/caching/FileDependency.php

@ -16,6 +16,8 @@ use yii\base\InvalidConfigException;
* If the last modification time of the file specified via [[fileName]] is changed,
* the dependency is considered as changed.
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/caching/MemCache.php

@ -53,6 +53,8 @@ use yii\base\InvalidConfigException;
* In the above, two memcache servers are used: server1 and server2. You can configure more properties of
* each server, such as `persistent`, `weight`, `timeout`. Please see [[MemCacheServer]] for available options.
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @property \Memcache|\Memcached $memcache The memcache (or memcached) object used by this cache component.
* This property is read-only.
* @property MemCacheServer[] $servers List of memcache server configurations. Note that the type of this

2
framework/caching/MemCacheServer.php

@ -13,6 +13,8 @@ namespace yii\caching;
* See [PHP manual](http://www.php.net/manual/en/function.Memcache-addServer.php) for detailed explanation
* of each configuration property.
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/caching/TagDependency.php

@ -21,6 +21,8 @@ namespace yii\caching;
* TagDependency::invalidate(Yii::$app->cache, 'user-123');
* ```
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/caching/WinCache.php

@ -15,6 +15,8 @@ namespace yii\caching;
*
* See [[Cache]] manual for common cache operations that are supported by WinCache.
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/caching/XCache.php

@ -16,6 +16,8 @@ namespace yii\caching;
*
* See [[Cache]] for common cache operations that XCache supports.
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/caching/ZendDataCache.php

@ -15,6 +15,8 @@ namespace yii\caching;
*
* See [[Cache]] for common cache operations that ZendDataCache supports.
*
* For more details and usage information on Cache, see the [guide article on caching](guide:caching-overview).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/data/ActiveDataProvider.php

@ -49,6 +49,8 @@ use yii\di\Instance;
* $posts = $provider->getModels();
* ```
*
* For more details and usage information on ActiveDataProvider, see the [guide article on data providers](guide:output-data-providers).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/data/ArrayDataProvider.php

@ -45,6 +45,8 @@ use yii\helpers\ArrayHelper;
* Note: if you want to use the sorting feature, you must configure the [[sort]] property
* so that the provider knows which columns can be sorted.
*
* For more details and usage information on ArrayDataProvider, see the [guide article on data providers](guide:output-data-providers).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/data/BaseDataProvider.php

@ -14,6 +14,8 @@ use yii\base\InvalidParamException;
/**
* BaseDataProvider provides a base class that implements the [[DataProviderInterface]].
*
* For more details and usage information on BaseDataProvider, see the [guide article on data providers](guide:output-data-providers).
*
* @property integer $count The number of data models in the current page. This property is read-only.
* @property array $keys The list of key values corresponding to [[models]]. Each data model in [[models]] is
* uniquely identified by the corresponding key value in this array.

2
framework/data/DataProviderInterface.php

@ -13,6 +13,8 @@ namespace yii\data;
* Data providers are components that sort and paginate data, and provide them to widgets
* such as [[\yii\grid\GridView]], [[\yii\widgets\ListView]].
*
* For more details and usage information on DataProviderInterface, see the [guide article on data providers](guide:output-data-providers).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/data/Pagination.php

@ -56,6 +56,8 @@ use yii\web\Request;
* ]);
* ```
*
* For more details and usage information on Pagination, see the [guide article on pagination](guide:output-pagination).
*
* @property integer $limit The limit of the data. This may be used to set the LIMIT value for a SQL statement
* for fetching the current page of data. Note that if the page size is infinite, a value -1 will be returned.
* This property is read-only.

2
framework/data/Sort.php

@ -66,6 +66,8 @@ use yii\web\Request;
* sorted by the orders specified by the Sort object. In the view, we show two hyperlinks
* that can lead to pages with the data sorted by the corresponding attributes.
*
* For more details and usage information on Sort, see the [guide article on sorting](guide:output-sorting).
*
* @property array $attributeOrders Sort directions indexed by attribute names. Sort direction can be either
* `SORT_ASC` for ascending order or `SORT_DESC` for descending order. Note that the type of this property
* differs in getter and setter. See [[getAttributeOrders()]] and [[setAttributeOrders()]] for details.

2
framework/data/SqlDataProvider.php

@ -58,6 +58,8 @@ use yii\di\Instance;
* to be the total number of rows (without pagination). And if you want to use the sorting feature,
* you must configure the [[sort]] property so that the provider knows which columns can be sorted.
*
* For more details and usage information on SqlDataProvider, see the [guide article on data providers](guide:output-data-providers).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/db/Migration.php

@ -33,6 +33,8 @@ use yii\di\Instance;
* information showing the method parameters and execution time, which may be useful when
* applying migrations.
*
* For more details and usage information on Migration, see the [guide article on Migration](guide:db-migrations).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/db/QueryBuilder.php

@ -18,6 +18,8 @@ use yii\helpers\ArrayHelper;
*
* QueryBuilder is also used by [[Command]] to build SQL statements such as INSERT, UPDATE, DELETE, CREATE TABLE.
*
* For more details and usage information on QueryBuilder, see the [guide article on query builders](guide:db-query-builder).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/di/Container.php

@ -89,6 +89,8 @@ use yii\helpers\ArrayHelper;
* $lister = new UserLister($finder);
* ```
*
* For more details and usage information on Container, see the [guide article on di-containers](guide:concept-di-container).
*
* @property array $definitions The list of the object definitions or the loaded shared objects (type or ID =>
* definition or instance). This property is read-only.
*

2
framework/di/ServiceLocator.php

@ -41,6 +41,8 @@ use yii\base\InvalidConfigException;
*
* Because [[\yii\base\Module]] extends from ServiceLocator, modules and the application are all service locators.
*
* For more details and usage information on ServiceLocator, see the [guide article on service locators](guide:concept-service-locator).
*
* @property array $components The list of the component definitions or the loaded component instances (ID =>
* definition or instance).
*

2
framework/grid/ActionColumn.php

@ -26,6 +26,8 @@ use yii\helpers\Url;
* ]
* ```
*
* For more details and usage information on ActionColumn, see the [guide article on data widgets](guide:output-data-widgets).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/grid/CheckboxColumn.php

@ -35,6 +35,8 @@ use yii\helpers\Json;
* // keys is an array consisting of the keys associated with the selected rows
* ```
*
* For more details and usage information on CheckboxColumn, see the [guide article on data widgets](guide:output-data-widgets).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/grid/Column.php

@ -14,6 +14,8 @@ use yii\helpers\Html;
/**
* Column is the base class of all [[GridView]] column classes.
*
* For more details and usage information on Column, see the [guide article on data widgets](guide:output-data-widgets).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/grid/DataColumn.php

@ -30,6 +30,8 @@ use yii\helpers\Inflector;
* may be used for calculation, while the actual cell content is a [[format|formatted]] version of that
* value which may contain HTML markup.
*
* For more details and usage information on DataColumn, see the [guide article on data widgets](guide:output-data-widgets).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/grid/GridView.php

@ -41,6 +41,8 @@ use yii\base\Model;
*
* The look and feel of a grid view can be customized using the large amount of properties.
*
* For more details and usage information on GridView, see the [guide article on data widgets](guide:output-data-widgets).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/grid/SerialColumn.php

@ -22,6 +22,8 @@ namespace yii\grid;
* ]
* ```
*
* For more details and usage information on SerialColumn, see the [guide article on data widgets](guide:output-data-widgets).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/helpers/ArrayHelper.php

@ -11,6 +11,8 @@ namespace yii\helpers;
* ArrayHelper provides additional array functionality that you can use in your
* application.
*
* For more details and usage information on ArrayHelper, see the [guide article on array helpers](guide:helper-array).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/helpers/Html.php

@ -14,6 +14,8 @@ namespace yii\helpers;
* tags they generate. You can specify for example. 'class', 'style' or 'id' for an html element
* using the `$options` parameter. See the documentation of the [[tag()]] method for more details.
*
* For more details and usage information on Html, see the [guide article on html helpers](guide:helper-html).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/helpers/Url.php

@ -10,6 +10,8 @@ namespace yii\helpers;
/**
* Url provides a set of static methods for managing URLs.
*
* For more details and usage information on Url, see the [guide article on url helpers](guide:helper-url).
*
* @author Alexander Makarov <sam@rmcreative.ru>
* @since 2.0
*/

2
framework/log/Logger.php

@ -24,6 +24,8 @@ use yii\base\Component;
* - [[Yii::beginProfile()]]
* - [[Yii::endProfile()]]
*
* For more details and usage information on Logger, see the [guide article on logging](guide:runtime-logging).
*
* When the application ends or [[flushInterval]] is reached, Logger will call [[flush()]]
* to send logged messages to different log targets, such as [[FileTarget|file]], [[EmailTarget|email]],
* or [[DbTarget|database]], with the help of the [[dispatcher]].

2
framework/log/Target.php

@ -29,6 +29,8 @@ use yii\web\Request;
* values. Defaults to 0, meaning all available levels. Note that the type of this property differs in getter
* and setter. See [[getLevels()]] and [[setLevels()]] for details.
*
* For more details and usage information on Target, see the [guide article on logging & targets](guide:runtime-logging).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/mail/BaseMailer.php

@ -20,6 +20,8 @@ use yii\web\View;
*
* @see BaseMessage
*
* For more details and usage information on BaseMailer, see the [guide article on mailing](guide:tutorial-mailing).
*
* @property View $view View instance. Note that the type of this property differs in getter and setter. See
* [[getView()]] and [[setView()]] for details.
* @property string $viewPath The directory that contains the view files for composing mail messages Defaults

2
framework/rbac/Assignment.php

@ -13,6 +13,8 @@ use yii\base\Object;
/**
* Assignment represents an assignment of a role to a user.
*
* For more details and usage information on Assignment, see the [guide article on security authorization](guide:security-authorization).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Alexander Kochetov <creocoder@gmail.com>
* @since 2.0

2
framework/rbac/BaseManager.php

@ -14,6 +14,8 @@ use yii\base\InvalidParamException;
/**
* BaseManager is a base class implementing [[ManagerInterface]] for RBAC management.
*
* For more details and usage information on DbManager, see the [guide article on security authorization](guide:security-authorization).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/rbac/CheckAccessInterface.php

@ -8,6 +8,8 @@
namespace yii\rbac;
/**
* For more details and usage information on CheckAccessInterface, see the [guide article on security authorization](guide:security-authorization).
*
* @author Sam Mousa <sam@mousa.nl>
* @since 2.0.9
*/

2
framework/rbac/DbManager.php

@ -30,6 +30,8 @@ use yii\di\Instance;
* You may change the names of the tables used to store the authorization and rule data by setting [[itemTable]],
* [[itemChildTable]], [[assignmentTable]] and [[ruleTable]].
*
* For more details and usage information on DbManager, see the [guide article on security authorization](guide:security-authorization).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Alexander Kochetov <creocoder@gmail.com>
* @since 2.0

2
framework/rbac/Item.php

@ -10,6 +10,8 @@ namespace yii\rbac;
use yii\base\Object;
/**
* For more details and usage information on Item, see the [guide article on security authorization](guide:security-authorization).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/rbac/ManagerInterface.php

@ -8,6 +8,8 @@
namespace yii\rbac;
/**
* For more details and usage information on ManagerInterface, see the [guide article on security authorization](guide:security-authorization).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/rbac/Permission.php

@ -8,6 +8,8 @@
namespace yii\rbac;
/**
* For more details and usage information on Permission, see the [guide article on security authorization](guide:security-authorization).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/rbac/PhpManager.php

@ -26,6 +26,8 @@ use yii\helpers\VarDumper;
* Note that PhpManager is not compatible with facebooks [HHVM](http://hhvm.com/) because
* it relies on writing php files and including them afterwards which is not supported by HHVM.
*
* For more details and usage information on PhpManager, see the [guide article on security authorization](guide:security-authorization).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Alexander Kochetov <creocoder@gmail.com>
* @author Christophe Boulain <christophe.boulain@gmail.com>

3
framework/rbac/Role.php

@ -8,6 +8,9 @@
namespace yii\rbac;
/**
*
* For more details and usage information on Role, see the [guide article on security authorization](guide:security-authorization).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/rbac/Rule.php

@ -12,6 +12,8 @@ use yii\base\Object;
/**
* Rule represents a business constraint that may be associated with a role, permission or assignment.
*
* For more details and usage information on Rule, see the [guide article on security authorization](guide:security-authorization).
*
* @author Alexander Makarov <sam@rmcreative.ru>
* @since 2.0
*/

2
framework/rest/Action.php

@ -15,6 +15,8 @@ use yii\web\NotFoundHttpException;
/**
* Action is the base class for action classes that implement RESTful API.
*
* For more details and usage information on Action, see the [guide article on rest controllers](guide:rest-controllers).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/rest/ActiveController.php

@ -32,6 +32,8 @@ use yii\web\ForbiddenHttpException;
* You should usually override [[checkAccess()]] to check whether the current user has the privilege to perform
* the specified action against the specified model.
*
* For more details and usage information on ActiveController, see the [guide article on rest controllers](guide:rest-controllers).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/rest/Controller.php

@ -25,6 +25,8 @@ use yii\filters\VerbFilter;
* 4. Rate limiting (see [[RateLimiter]]);
* 5. Formatting response data (see [[serializeData()]]).
*
* For more details and usage information on Controller, see the [guide article on rest controllers](guide:rest-controllers).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/rest/CreateAction.php

@ -15,6 +15,8 @@ use yii\web\ServerErrorHttpException;
/**
* CreateAction implements the API endpoint for creating a new model from the given data.
*
* For more details and usage information on CreateAction, see the [guide article on rest controllers](guide:rest-controllers).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/rest/DeleteAction.php

@ -13,6 +13,8 @@ use yii\web\ServerErrorHttpException;
/**
* DeleteAction implements the API endpoint for deleting a model.
*
* For more details and usage information on DeleteAction, see the [guide article on rest controllers](guide:rest-controllers).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

4
framework/rest/IndexAction.php

@ -11,6 +11,10 @@ use Yii;
use yii\data\ActiveDataProvider;
/**
* IndexAction implements the API endpoint for listing multiple models.
*
* For more details and usage information on IndexAction, see the [guide article on rest controllers](guide:rest-controllers).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/rest/OptionsAction.php

@ -12,6 +12,8 @@ use Yii;
/**
* OptionsAction responds to the OPTIONS request by sending back an `Allow` header.
*
* For more details and usage information on OptionsAction, see the [guide article on rest controllers](guide:rest-controllers).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/rest/UpdateAction.php

@ -15,6 +15,8 @@ use yii\web\ServerErrorHttpException;
/**
* UpdateAction implements the API endpoint for updating a model.
*
* For more details and usage information on UpdateAction, see the [guide article on rest controllers](guide:rest-controllers).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/rest/UrlRule.php

@ -52,6 +52,8 @@ use yii\web\CompositeUrlRule;
* The controller ID used in the pattern will be automatically pluralized (e.g. `user` becomes `users`
* as shown in the above examples).
*
* For more details and usage information on UrlRule, see the [guide article on rest routing](guide:rest-routing).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/rest/ViewAction.php

@ -12,6 +12,8 @@ use Yii;
/**
* ViewAction implements the API endpoint for returning the detailed information about a model.
*
* For more details and usage information on ViewAction, see the [guide article on rest controllers](guide:rest-controllers).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/test/ActiveFixture.php

@ -23,6 +23,8 @@ use yii\db\TableSchema;
* After the fixture is loaded, you can access the loaded data via the [[data]] property. If you set [[modelClass]],
* you will also be able to retrieve an instance of [[modelClass]] with the populated data via [[getModel()]].
*
* For more details and usage information on ActiveFixture, see the [guide article on fixtures](guide:test-fixtures).
*
* @property TableSchema $tableSchema The schema information of the database table associated with this
* fixture. This property is read-only.
*

2
framework/test/ArrayFixture.php

@ -14,6 +14,8 @@ use yii\base\InvalidConfigException;
/**
* ArrayFixture represents arbitrary fixture that can be loaded from PHP files.
*
* For more details and usage information on ArrayFixture, see the [guide article on fixtures](guide:test-fixtures).
*
* @author Mark Jebri <mark.github@yandex.ru>
* @since 2.0
*/

2
framework/test/BaseActiveFixture.php

@ -14,6 +14,8 @@ use yii\base\InvalidConfigException;
/**
* BaseActiveFixture is the base class for fixture classes that support accessing fixture data as ActiveRecord objects.
*
* For more details and usage information on BaseActiveFixture, see the [guide article on fixtures](guide:test-fixtures).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/test/DbFixture.php

@ -17,6 +17,8 @@ use yii\base\Object;
*
* DbFixture provides the [[db]] connection to be used by DB fixtures.
*
* For more details and usage information on DbFixture, see the [guide article on fixtures](guide:test-fixtures).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/test/Fixture.php

@ -24,6 +24,8 @@ use yii\base\Component;
* You should normally override [[load()]] to specify how to set up a fixture; and override [[unload()]]
* for clearing up a fixture.
*
* For more details and usage information on Fixture, see the [guide article on fixtures](guide:test-fixtures).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/test/FixtureTrait.php

@ -19,6 +19,8 @@ use yii\base\InvalidConfigException;
* Also, if the fixture is an instance of [[ActiveFixture]], you will be able to access AR models
* through the syntax `$this->fixtureName('model name')`.
*
* For more details and usage information on FixtureTrait, see the [guide article on fixtures](guide:test-fixtures).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/test/InitDbFixture.php

@ -21,6 +21,8 @@ use Yii;
* You should normally use InitDbFixture to prepare a skeleton test database.
* Other DB fixtures will then add specific tables and data to this database.
*
* For more details and usage information on InitDbFixture, see the [guide article on fixtures](guide:test-fixtures).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/validators/Validator.php

@ -46,6 +46,8 @@ use yii\base\NotSupportedException;
* - `url`: [[UrlValidator]]
* - `ip`: [[IpValidator]]
*
* For more details and usage information on Validator, see the [guide article on validators](guide:input-validation).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/web/Application.php

@ -14,6 +14,8 @@ use yii\base\InvalidRouteException;
/**
* Application is the base class for all web application classes.
*
* For more details and usage information on Application, see the [guide article on applications](guide:structure-applications).
*
* @property ErrorHandler $errorHandler The error handler application component. This property is read-only.
* @property string $homeUrl The homepage URL.
* @property Request $request The request component. This property is read-only.

2
framework/web/AssetBundle.php

@ -22,6 +22,8 @@ use Yii;
* An asset bundle can depend on other asset bundles. When registering an asset bundle
* with a view, all its dependent asset bundles will be automatically registered.
*
* For more details and usage information on AssetBundle, see the [guide article on assets](guide:structure-assets).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/web/AssetManager.php

@ -30,6 +30,8 @@ use yii\helpers\Url;
* ],
* ]
* ```
*
* For more details and usage information on AssetManager, see the [guide article on assets](guide:structure-assets).
*
* @property AssetConverterInterface $converter The asset converter. Note that the type of this property
* differs in getter and setter. See [[getConverter()]] and [[setConverter()]] for details.

2
framework/web/Controller.php

@ -14,6 +14,8 @@ use yii\helpers\Url;
/**
* Controller is the base class of web controllers.
*
* For more details and usage information on Controller, see the [guide article on controllers](guide:structure-controllers).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/web/Cookie.php

@ -10,6 +10,8 @@ namespace yii\web;
/**
* Cookie represents information related with a cookie, such as [[name]], [[value]], [[domain]], etc.
*
* For more details and usage information on Cookie, see the [guide article on handling cookies](guide:runtime-sessions-cookies).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @since 2.0
*/

2
framework/web/CookieCollection.php

@ -15,6 +15,8 @@ use yii\base\Object;
/**
* CookieCollection maintains the cookies available in the current request.
*
* For more details and usage information on CookieCollection, see the [guide article on handling cookies](guide:runtime-sessions-cookies).
*
* @property integer $count The number of cookies in the collection. This property is read-only.
* @property ArrayIterator $iterator An iterator for traversing the cookies in the collection. This property
* is read-only.

2
framework/web/ErrorHandler.php

@ -22,6 +22,8 @@ use yii\helpers\VarDumper;
* ErrorHandler is configured as an application component in [[\yii\base\Application]] by default.
* You can access that instance via `Yii::$app->errorHandler`.
*
* For more details and usage information on ErrorHandler, see the [guide article on handling errors](guide:runtime-handling-errors).
*
* @author Qiang Xue <qiang.xue@gmail.com>
* @author Timur Ruziev <resurtm@gmail.com>
* @since 2.0

2
framework/web/Request.php

@ -21,6 +21,8 @@ use yii\helpers\StringHelper;
* Request is configured as an application component in [[\yii\web\Application]] by default.
* You can access that instance via `Yii::$app->request`.
*
* For more details and usage information on Request, see the [guide article on requests](guide:runtime-requests).
*
* @property string $absoluteUrl The currently requested absolute URL. This property is read-only.
* @property array $acceptableContentTypes The content types ordered by the quality score. Types with the
* highest scores will be returned first. The array keys are the content types, while the array values are the

2
framework/web/Response.php

@ -35,6 +35,8 @@ use yii\helpers\StringHelper;
* ]
* ```
*
* For more details and usage information on Response, see the [guide article on responses](guide:runtime-responses).
*
* @property CookieCollection $cookies The cookie collection. This property is read-only.
* @property string $downloadHeaders The attachment file name. This property is write-only.
* @property HeaderCollection $headers The header collection. This property is read-only.

2
framework/web/Session.php

@ -43,6 +43,8 @@ use yii\base\InvalidParamException;
* useful for displaying confirmation messages. To use flash messages, simply
* call methods such as [[setFlash()]], [[getFlash()]].
*
* For more details and usage information on Session, see the [guide article on sessions](guide:runtime-sessions-cookies).
*
* @property array $allFlashes Flash messages (key => message or key => [message1, message2]). This property
* is read-only.
* @property array $cookieParams The session cookie parameters. This property is read-only.

2
framework/web/UploadedFile.php

@ -18,6 +18,8 @@ use yii\helpers\Html;
* You may also query other information about the file, including [[name]],
* [[tempName]], [[type]], [[size]] and [[error]].
*
* For more details and usage information on UploadedFile, see the [guide article on handling uploads](guide:input-file-upload).
*
* @property string $baseName Original file base name. This property is read-only.
* @property string $extension File extension. This property is read-only.
* @property boolean $hasError Whether there is an error with the uploaded file. Check [[error]] for detailed

Some files were not shown because too many files have changed in this diff Show More

Loading…
Cancel
Save