update of @Property annotations

framework/yii/base/Action.php

@@ -28,7 +28,8 @@
  * And the parameters provided for the action are: `array('id' => 1)`.
  * Then the `run()` method will be invoked as `run(1)` automatically.
  *
- * @property string $uniqueId The unique ID of this action among the whole application.
+ * @property string $uniqueId The unique ID of this action among the whole application. This property is
+ * read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/base/Application.php

@@ -14,22 +14,23 @@
 /**
  * Application is the base class for all application classes.
  *
- * @property \yii\rbac\Manager $authManager The auth manager for this application.
+ * @property \yii\rbac\Manager $authManager The auth manager for this application. This property is read-only.
  * @property \yii\caching\Cache $cache The cache application component. Null if the component is not enabled.
- * @property \yii\db\Connection $db The database connection.
- * @property ErrorHandler $errorHandler The error handler application component.
- * @property \yii\base\Formatter $formatter The formatter application component.
- * @property \yii\i18n\I18N $i18N The internationalization component.
- * @property \yii\log\Logger $log The log component.
- * @property \yii\web\Request|\yii\console\Request $request The request component.
- * @property string $runtimePath The directory that stores runtime files.
- * Defaults to the "runtime" subdirectory under [[basePath]].
+ * This property is read-only.
+ * @property \yii\db\Connection $db The database connection. This property is read-only.
+ * @property ErrorHandler $errorHandler The error handler application component. This property is read-only.
+ * @property \yii\base\Formatter $formatter The formatter application component. This property is read-only.
+ * @property \yii\i18n\I18N $i18N The internationalization component. This property is read-only.
+ * @property \yii\log\Logger $log The log component. This property is read-only.
+ * @property \yii\web\Request|\yii\console\Request $request The request component. This property is read-only.
+ * @property string $runtimePath The directory that stores runtime files. Defaults to the "runtime"
+ * subdirectory under [[basePath]].
  * @property string $timeZone The time zone used by this application.
- * @property string $uniqueId The unique ID of the module.
- * @property \yii\web\UrlManager $urlManager The URL manager for this application.
- * @property string $vendorPath The directory that stores vendor files.
- * Defaults to "vendor" directory under [[basePath]].
- * @property View $view The view object that is used to render various view files.
+ * @property string $uniqueId The unique ID of the module. This property is read-only.
+ * @property \yii\web\UrlManager $urlManager The URL manager for this application. This property is read-only.
+ * @property string $vendorPath The directory that stores vendor files. Defaults to "vendor" directory under
+ * [[basePath]].
+ * @property View $view The view object that is used to render various view files. This property is read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/base/Component.php

@@ -11,6 +11,9 @@
 
 /**
  * @include @yii/base/Component.md
+ *
+ * @property Behavior[] $behaviors List of behaviors attached to this component. This property is read-only.
+ *
  * @author Qiang Xue <[email protected]>
  * @since 2.0
  */

framework/yii/base/Controller.php

@@ -12,11 +12,15 @@
 /**
  * Controller is the base class for classes containing controller logic.
  *
- * @property array $actionParams The request parameters (name-value pairs) to be used for action parameter binding.
- * @property string $route The route (module ID, controller ID and action ID) of the current request.
- * @property string $uniqueId The controller ID that is prefixed with the module ID (if any).
+ * @property array $actionParams The request parameters (name-value pairs) to be used for action parameter
+ * binding. This property is read-only.
+ * @property string $route The route (module ID, controller ID and action ID) of the current request. This
+ * property is read-only.
+ * @property string $uniqueId The controller ID that is prefixed with the module ID (if any). This property is
+ * read-only.
  * @property View $view The view object that can be used to render views or view files.
- * @property string $viewPath The directory containing the view files for this controller.
+ * @property string $viewPath The directory containing the view files for this controller. This property is
+ * read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/base/View.php

@@ -21,7 +21,8 @@
  *
  * View provides a set of methods (e.g. [[render()]]) for rendering purpose.
  *
- * @property \yii\web\AssetManager $assetManager The asset manager. Defaults to the "assetManager" application component.
+ * @property \yii\web\AssetManager $assetManager The asset manager. Defaults to the "assetManager" application
+ * component.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/base/Widget.php

@@ -14,7 +14,8 @@
  *
  * @property string $id ID of the widget.
  * @property View $view The view object that can be used to render views or view files.
- * @property string $viewPath The directory containing the view files for this widget.
+ * @property string $viewPath The directory containing the view files for this widget. This property is
+ * read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/caching/RedisCache.php

@@ -39,6 +39,8 @@
  * )
  * ~~~
  *
+ * @property \yii\db\redis\Connection $connection This property is read-only.
+ *
  * @author Carsten Brandt <[email protected]>
  * @since 2.0
  */

framework/yii/captcha/CaptchaAction.php

@@ -29,7 +29,7 @@
  *    to be validated by the 'captcha' validator.
  * 3. In the controller view, insert a [[Captcha]] widget in the form.
  *
- * @property string $verifyCode The verification code.
+ * @property string $verifyCode The verification code. This property is read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/captcha/CaptchaValidator.php

@@ -18,7 +18,7 @@
  *
  * CaptchaValidator should be used together with [[CaptchaAction]].
  *
- * @property \yii\captcha\CaptchaAction $captchaAction The action object.
+ * @property \yii\captcha\CaptchaAction $captchaAction The action object. This property is read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/console/Application.php

@@ -45,7 +45,7 @@
  * yii help
  * ~~~
  *
- * @property Response $response The response component.
+ * @property Response $response The response component. This property is read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/console/controllers/HelpController.php

@@ -31,7 +31,7 @@
  * In the above, if the command name is not provided, all
  * available commands will be displayed.
  *
- * @property array $commands All available command names.
+ * @property array $commands All available command names. This property is read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/data/ActiveDataProvider.php

@@ -49,10 +49,10 @@
  * $posts = $provider->getModels();
  * ~~~
  *
- * @property integer $count The number of data models in the current page.
- * @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.
- * @property array $models The list of data models in the current page.
+ * @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. This property is read-only.
+ * @property array $models The list of data models in the current page. This property is read-only.
  * @property integer $totalCount Total number of possible data models.
  *
  * @author Qiang Xue <[email protected]>

framework/yii/data/ArrayDataProvider.php

@@ -47,8 +47,8 @@
  * 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.
  *
- * @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.
+ * @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.
  * @property array $models The list of data models in the current page.
  * @property integer $totalCount Total number of possible data models.
  *

framework/yii/data/DataProvider.php

@@ -16,8 +16,9 @@
  *
  * It implements the [[getPagination()]] and [[getSort()]] methods as specified by the [[IDataProvider]] interface.
  *
- * @property integer $count The number of data models in the current page.
- * @property Pagination $pagination The pagination object. If this is false, it means the pagination is disabled.
+ * @property integer $count The number of data models in the current page. This property is read-only.
+ * @property Pagination $pagination The pagination object. If this is false, it means the pagination is
+ * disabled.
  * @property Sort $sort The sorting object. If this is false, it means the sorting is disabled.
  *
  * @author Qiang Xue <[email protected]>

framework/yii/data/Pagination.php

@@ -53,13 +53,13 @@
  * ));
  * ~~~
  *
- * @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.
- * @property integer $offset The offset of the data. This may be used to set the
- * OFFSET value for a SQL statement for fetching the current page of data.
+ * @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.
+ * @property integer $offset The offset of the data. This may be used to set the OFFSET value for a SQL
+ * statement for fetching the current page of data. This property is read-only.
  * @property integer $page The zero-based current page number.
- * @property integer $pageCount Number of pages.
+ * @property integer $pageCount Number of pages. This property is read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/data/Sort.php

@@ -65,11 +65,10 @@
  * 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.
  *
- * @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.
- * @property array $orders The columns (keys) and their corresponding sort directions (values).
- * This can be passed to [[\yii\db\Query::orderBy()]] to construct a DB query.
+ * @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. This property is read-only.
+ * @property array $orders The columns (keys) and their corresponding sort directions (values). This can be
+ * passed to [[\yii\db\Query::orderBy()]] to construct a DB query. This property is read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/db/ActiveRecord.php

@@ -22,13 +22,16 @@
  *
  * @include @yii/db/ActiveRecord.md
  *
- * @property Connection $db the database connection used by this AR class.
- * @property TableSchema $tableSchema the schema information of the DB table associated with this AR class.
- * @property array $oldAttributes the old attribute values (name-value pairs).
- * @property array $dirtyAttributes the changed attribute values (name-value pairs).
- * @property boolean $isNewRecord whether the record is new and should be inserted when calling [[save()]].
- * @property mixed $primaryKey the primary key value.
- * @property mixed $oldPrimaryKey the old primary key value.
+ * @property array $dirtyAttributes The changed attribute values (name-value pairs). This property is
+ * read-only.
+ * @property boolean $isNewRecord Whether the record is new and should be inserted when calling [[save()]].
+ * @property array $oldAttributes The old attribute values (name-value pairs).
+ * @property mixed $oldPrimaryKey The old primary key value. An array (column name => column value) is
+ * returned if the primary key is composite or `$asArray` is true. A string is returned otherwise (null will be
+ * returned if the key value is null). This property is read-only.
+ * @property mixed $primaryKey The primary key value. An array (column name => column value) is returned if
+ * the primary key is composite or `$asArray` is true. A string is returned otherwise (null will be returned if
+ * the key value is null). This property is read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/db/Command.php

@@ -44,7 +44,7 @@
  *
  * To build SELECT SQL statements, please use [[QueryBuilder]] instead.
  *
- * @property string $rawSql The raw SQL.
+ * @property string $rawSql The raw SQL. This property is read-only.
  * @property string $sql The SQL statement to be executed.
  *
  * @author Qiang Xue <[email protected]>

framework/yii/db/Connection.php

@@ -89,13 +89,16 @@
  * )
  * ~~~
  *
+ * @property string $driverName Name of the DB driver. This property is read-only.
  * @property boolean $isActive Whether the DB connection is established. This property is read-only.
- * @property Transaction $transaction The currently active transaction. Null if no active transaction.
- * @property Schema $schema The database schema information for the current connection.
- * @property QueryBuilder $queryBuilder The query builder.
- * @property string $lastInsertID The row ID of the last row inserted, or the last value retrieved from the sequence object.
- * @property string $driverName Name of the DB driver currently being used.
- * @property array $querySummary The statistical results of SQL queries.
+ * @property string $lastInsertID The row ID of the last row inserted, or the last value retrieved from the
+ * sequence object. This property is read-only.
+ * @property QueryBuilder $queryBuilder The query builder for the current DB connection. This property is
+ * read-only.
+ * @property Schema $schema The schema information for the database opened by this connection. This property
+ * is read-only.
+ * @property Transaction $transaction The currently active transaction. Null if no active transaction. This
+ * property is read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/db/DataReader.php

@@ -39,10 +39,10 @@
  * [[fetchMode]]. See the [PHP manual](http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php)
  * for more details about possible fetch mode.
  *
- * @property integer $columnCount The number of columns in the result set.
- * @property mixed $fetchMode Fetch mode.
- * @property boolean $isClosed Whether the reader is closed or not.
- * @property integer $rowCount Number of rows contained in the result.
+ * @property integer $columnCount The number of columns in the result set. This property is read-only.
+ * @property mixed $fetchMode Fetch mode. This property is write-only.
+ * @property boolean $isClosed Whether the reader is closed or not. This property is read-only.
+ * @property integer $rowCount Number of rows contained in the result. This property is read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/db/Schema.php

@@ -19,8 +19,12 @@
  *
  * Schema represents the database schema information that is DBMS specific.
  *
- * @property string $lastInsertID The row ID of the last row inserted, or the last value retrieved from the sequence object.
- * @property QueryBuilder $queryBuilder The query builder for this connection.
+ * @property string $lastInsertID The row ID of the last row inserted, or the last value retrieved from the
+ * sequence object. This property is read-only.
+ * @property QueryBuilder $queryBuilder The query builder for this connection. This property is read-only.
+ * @property string[] $tableNames All table names in the database. This property is read-only.
+ * @property TableSchema[] $tableSchemas The metadata for all tables in the database. Each array element is an
+ * instance of [[TableSchema]] or its child class. This property is read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/db/TableSchema.php

@@ -13,7 +13,7 @@
 /**
  * TableSchema represents the metadata of a database table.
  *
- * @property array $columnNames List of column names.
+ * @property array $columnNames List of column names. This property is read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/db/Transaction.php

@@ -29,8 +29,8 @@
  * }
  * ~~~
  *
- * @property boolean $isActive Whether this transaction is active. Only an active transaction
- * can [[commit()]] or [[rollback()]].
+ * @property boolean $isActive Whether this transaction is active. Only an active transaction can [[commit()]]
+ * or [[rollback()]]. This property is read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/db/redis/Connection.php

@@ -21,9 +21,10 @@
  * @method mixed get($key) Set the string value of a key
  * TODO document methods
  *
- * @property string $driverName Name of the DB driver.
- * @property boolean $isActive Whether the DB connection is established.
- * @property Transaction $transaction The currently active transaction. Null if no active transaction.
+ * @property string $driverName Name of the DB driver. This property is read-only.
+ * @property boolean $isActive Whether the DB connection is established. This property is read-only.
+ * @property Transaction $transaction The currently active transaction. Null if no active transaction. This
+ * property is read-only.
  *
  * @author Carsten Brandt <[email protected]>
  * @since 2.0

framework/yii/db/redis/Transaction.php

@@ -15,8 +15,8 @@
 /**
  * Transaction represents a DB transaction.
  *
- * @property boolean $isActive Whether this transaction is active. Only an active transaction
- * can [[commit()]] or [[rollBack()]].
+ * @property boolean $isActive Whether this transaction is active. Only an active transaction can [[commit()]]
+ * or [[rollBack()]]. This property is read-only.
  *
  * @author Carsten Brandt <[email protected]>
  * @since 2.0

framework/yii/debug/Panel.php

@@ -14,10 +14,10 @@
  * Panel is a base class for debugger panel classes. It defines how data should be collected,
  * what should be displayed at debug toolbar and on debugger details view.
  *
- * @property string $detail Content that is displayed in debugger detail view.
- * @property string $name Name of the panel.
- * @property string $summary Content that is displayed at debug toolbar.
- * @property string $url URL pointing to panel detail view.
+ * @property string $detail Content that is displayed in debugger detail view. This property is read-only.
+ * @property string $name Name of the panel. This property is read-only.
+ * @property string $summary Content that is displayed at debug toolbar. This property is read-only.
+ * @property string $url URL pointing to panel detail view. This property is read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0

framework/yii/gii/CodeFile.php

@@ -16,8 +16,9 @@
 /**
  * CodeFile represents a code file to be generated.
  *
- * @property string $relativePath The code file path relative to the application base path.
- * @property string $type The code file extension (e.g. php, txt).
+ * @property string $relativePath The code file path relative to the application base path. This property is
+ * read-only.
+ * @property string $type The code file extension (e.g. php, txt). This property is read-only.
  *
  * @author Qiang Xue <[email protected]>
  * @since 2.0