diff --git a/framework/yii/base/Action.php b/framework/yii/base/Action.php index 2ec73ce..2693003 100644 --- a/framework/yii/base/Action.php +++ b/framework/yii/base/Action.php @@ -28,7 +28,8 @@ use Yii; * 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 * @since 2.0 diff --git a/framework/yii/base/Application.php b/framework/yii/base/Application.php index 1ebc230..9efb6ce 100644 --- a/framework/yii/base/Application.php +++ b/framework/yii/base/Application.php @@ -14,22 +14,23 @@ use yii\web\HttpException; /** * 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 * @since 2.0 diff --git a/framework/yii/base/Component.php b/framework/yii/base/Component.php index 5ff8ae4..6aebc92 100644 --- a/framework/yii/base/Component.php +++ b/framework/yii/base/Component.php @@ -11,6 +11,9 @@ use Yii; /** * @include @yii/base/Component.md + * + * @property Behavior[] $behaviors List of behaviors attached to this component. This property is read-only. + * * @author Qiang Xue * @since 2.0 */ diff --git a/framework/yii/base/Controller.php b/framework/yii/base/Controller.php index 18b7067..20f6e2b 100644 --- a/framework/yii/base/Controller.php +++ b/framework/yii/base/Controller.php @@ -12,11 +12,15 @@ use Yii; /** * 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 * @since 2.0 diff --git a/framework/yii/base/View.php b/framework/yii/base/View.php index ead1e12..4d3d996 100644 --- a/framework/yii/base/View.php +++ b/framework/yii/base/View.php @@ -21,7 +21,8 @@ use yii\widgets\FragmentCache; * * 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 * @since 2.0 diff --git a/framework/yii/base/Widget.php b/framework/yii/base/Widget.php index 3230101..943d007 100644 --- a/framework/yii/base/Widget.php +++ b/framework/yii/base/Widget.php @@ -14,7 +14,8 @@ use Yii; * * @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 * @since 2.0 diff --git a/framework/yii/caching/RedisCache.php b/framework/yii/caching/RedisCache.php index df56852..09ce599 100644 --- a/framework/yii/caching/RedisCache.php +++ b/framework/yii/caching/RedisCache.php @@ -39,6 +39,8 @@ use yii\db\redis\Connection; * ) * ~~~ * + * @property \yii\db\redis\Connection $connection This property is read-only. + * * @author Carsten Brandt * @since 2.0 */ diff --git a/framework/yii/captcha/CaptchaAction.php b/framework/yii/captcha/CaptchaAction.php index a30d289..e1761a1 100644 --- a/framework/yii/captcha/CaptchaAction.php +++ b/framework/yii/captcha/CaptchaAction.php @@ -29,7 +29,7 @@ use yii\base\InvalidConfigException; * 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 * @since 2.0 diff --git a/framework/yii/captcha/CaptchaValidator.php b/framework/yii/captcha/CaptchaValidator.php index 11d171b..97bfd1b 100644 --- a/framework/yii/captcha/CaptchaValidator.php +++ b/framework/yii/captcha/CaptchaValidator.php @@ -18,7 +18,7 @@ use yii\validators\Validator; * * 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 * @since 2.0 diff --git a/framework/yii/console/Application.php b/framework/yii/console/Application.php index 9ae7263..bbdd4e1 100644 --- a/framework/yii/console/Application.php +++ b/framework/yii/console/Application.php @@ -45,7 +45,7 @@ use yii\base\InvalidRouteException; * yii help * ~~~ * - * @property Response $response The response component. + * @property Response $response The response component. This property is read-only. * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/console/controllers/HelpController.php b/framework/yii/console/controllers/HelpController.php index cc9264b..f0e72cd 100644 --- a/framework/yii/console/controllers/HelpController.php +++ b/framework/yii/console/controllers/HelpController.php @@ -31,7 +31,7 @@ use yii\helpers\Inflector; * 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 * @since 2.0 diff --git a/framework/yii/data/ActiveDataProvider.php b/framework/yii/data/ActiveDataProvider.php index 5b94b5a..e36ef90 100644 --- a/framework/yii/data/ActiveDataProvider.php +++ b/framework/yii/data/ActiveDataProvider.php @@ -49,10 +49,10 @@ use yii\db\Connection; * $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 diff --git a/framework/yii/data/ArrayDataProvider.php b/framework/yii/data/ArrayDataProvider.php index 9b92fdb..d6eaca7 100644 --- a/framework/yii/data/ArrayDataProvider.php +++ b/framework/yii/data/ArrayDataProvider.php @@ -47,8 +47,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. * - * @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. * diff --git a/framework/yii/data/DataProvider.php b/framework/yii/data/DataProvider.php index 677c7b4..8e648cc 100644 --- a/framework/yii/data/DataProvider.php +++ b/framework/yii/data/DataProvider.php @@ -16,8 +16,9 @@ use yii\base\InvalidParamException; * * 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 diff --git a/framework/yii/data/Pagination.php b/framework/yii/data/Pagination.php index 6383f8c..1625fde 100644 --- a/framework/yii/data/Pagination.php +++ b/framework/yii/data/Pagination.php @@ -53,13 +53,13 @@ use yii\base\Object; * )); * ~~~ * - * @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 * @since 2.0 diff --git a/framework/yii/data/Sort.php b/framework/yii/data/Sort.php index 7422c7f..78fe2e0 100644 --- a/framework/yii/data/Sort.php +++ b/framework/yii/data/Sort.php @@ -65,11 +65,10 @@ use yii\helpers\Inflector; * 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 * @since 2.0 diff --git a/framework/yii/db/ActiveRecord.php b/framework/yii/db/ActiveRecord.php index 5aa9807..35d7305 100644 --- a/framework/yii/db/ActiveRecord.php +++ b/framework/yii/db/ActiveRecord.php @@ -22,13 +22,16 @@ use yii\helpers\Inflector; * * @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 * @since 2.0 diff --git a/framework/yii/db/Command.php b/framework/yii/db/Command.php index 2af07bb..d7db35c 100644 --- a/framework/yii/db/Command.php +++ b/framework/yii/db/Command.php @@ -44,7 +44,7 @@ use yii\caching\Cache; * * 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 diff --git a/framework/yii/db/Connection.php b/framework/yii/db/Connection.php index 26c4537..342fa15 100644 --- a/framework/yii/db/Connection.php +++ b/framework/yii/db/Connection.php @@ -89,13 +89,16 @@ use yii\caching\Cache; * ) * ~~~ * + * @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 * @since 2.0 diff --git a/framework/yii/db/DataReader.php b/framework/yii/db/DataReader.php index 9f6fac9..ddfcf29 100644 --- a/framework/yii/db/DataReader.php +++ b/framework/yii/db/DataReader.php @@ -39,10 +39,10 @@ use yii\base\InvalidCallException; * [[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 * @since 2.0 diff --git a/framework/yii/db/Schema.php b/framework/yii/db/Schema.php index 6795ad4..4fd1cd1 100644 --- a/framework/yii/db/Schema.php +++ b/framework/yii/db/Schema.php @@ -19,8 +19,12 @@ use yii\caching\GroupDependency; * * 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 * @since 2.0 diff --git a/framework/yii/db/TableSchema.php b/framework/yii/db/TableSchema.php index a0d2c15..d599388 100644 --- a/framework/yii/db/TableSchema.php +++ b/framework/yii/db/TableSchema.php @@ -13,7 +13,7 @@ use yii\base\InvalidParamException; /** * 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 * @since 2.0 diff --git a/framework/yii/db/Transaction.php b/framework/yii/db/Transaction.php index 3be2d34..e0b90d9 100644 --- a/framework/yii/db/Transaction.php +++ b/framework/yii/db/Transaction.php @@ -29,8 +29,8 @@ use yii\base\InvalidConfigException; * } * ~~~ * - * @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 * @since 2.0 diff --git a/framework/yii/db/redis/Connection.php b/framework/yii/db/redis/Connection.php index 00ed80f..ea59f22 100644 --- a/framework/yii/db/redis/Connection.php +++ b/framework/yii/db/redis/Connection.php @@ -21,9 +21,10 @@ use yii\helpers\StringHelper; * @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 * @since 2.0 diff --git a/framework/yii/db/redis/Transaction.php b/framework/yii/db/redis/Transaction.php index 8458c85..024f821 100644 --- a/framework/yii/db/redis/Transaction.php +++ b/framework/yii/db/redis/Transaction.php @@ -15,8 +15,8 @@ use yii\db\Exception; /** * 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 * @since 2.0 diff --git a/framework/yii/debug/Panel.php b/framework/yii/debug/Panel.php index 6c01362..6782264 100644 --- a/framework/yii/debug/Panel.php +++ b/framework/yii/debug/Panel.php @@ -14,10 +14,10 @@ use yii\base\Component; * 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 * @since 2.0 diff --git a/framework/yii/gii/CodeFile.php b/framework/yii/gii/CodeFile.php index 6fcbdbd..2f21b4c 100644 --- a/framework/yii/gii/CodeFile.php +++ b/framework/yii/gii/CodeFile.php @@ -16,8 +16,9 @@ use yii\helpers\StringHelper; /** * 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 * @since 2.0 diff --git a/framework/yii/gii/Generator.php b/framework/yii/gii/Generator.php index 387f523..f79b428 100644 --- a/framework/yii/gii/Generator.php +++ b/framework/yii/gii/Generator.php @@ -27,9 +27,11 @@ use yii\base\View; * - [[generate()]]: generates the code based on the current user input and the specified code template files. * This is the place where main code generation code resides. * - * @property string $description The detailed description of the generator. - * @property string $stickyDataFile The file path that stores the sticky attribute values. - * @property string $templatePath The root path of the template files that are currently being used. + * @property string $description The detailed description of the generator. This property is read-only. + * @property string $stickyDataFile The file path that stores the sticky attribute values. This property is + * read-only. + * @property string $templatePath The root path of the template files that are currently being used. This + * property is read-only. * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/log/Logger.php b/framework/yii/log/Logger.php index 2d3f7c1..54f3a49 100644 --- a/framework/yii/log/Logger.php +++ b/framework/yii/log/Logger.php @@ -61,11 +61,12 @@ use yii\base\InvalidConfigException; * When the application ends or [[flushInterval]] is reached, Logger will call [[flush()]] * to send logged messages to different log targets, such as file, email, Web. * - * @property array $dbProfiling The first element indicates the number of SQL statements executed, - * and the second element the total time spent in SQL execution. - * @property float $elapsedTime The total elapsed time in seconds for current request. + * @property array $dbProfiling The first element indicates the number of SQL statements executed, and the + * second element the total time spent in SQL execution. This property is read-only. + * @property float $elapsedTime The total elapsed time in seconds for current request. This property is + * read-only. * @property array $profiling The profiling results. Each array element has the following structure: - * `array($token, $category, $time)`. + * `array($token, $category, $time)`. This property is read-only. * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/log/Target.php b/framework/yii/log/Target.php index 12b5d15..c858412 100644 --- a/framework/yii/log/Target.php +++ b/framework/yii/log/Target.php @@ -22,8 +22,8 @@ use yii\base\InvalidConfigException; * satisfying both filter conditions will be handled. Additionally, you * may specify [[except]] to exclude messages of certain categories. * - * @property integer $levels The message levels that this target is interested in. This is a bitmap of - * level values. Defaults to 0, meaning all available levels. + * @property integer $levels The message levels that this target is interested in. This is a bitmap of level + * values. Defaults to 0, meaning all available levels. * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/rbac/DbManager.php b/framework/yii/rbac/DbManager.php index 90d301e..46c375f 100644 --- a/framework/yii/rbac/DbManager.php +++ b/framework/yii/rbac/DbManager.php @@ -24,6 +24,8 @@ use yii\base\InvalidParamException; * the three tables used to store the authorization data by setting [[itemTable]], * [[itemChildTable]] and [[assignmentTable]]. * + * @property Item[] $items The authorization items of the specific type. This property is read-only. + * * @author Qiang Xue * @author Alexander Kochetov * @since 2.0 diff --git a/framework/yii/rbac/Item.php b/framework/yii/rbac/Item.php index 4c09e28..f7930c1 100644 --- a/framework/yii/rbac/Item.php +++ b/framework/yii/rbac/Item.php @@ -18,6 +18,7 @@ use yii\base\Object; * A user may be assigned one or several authorization items (called [[Assignment]] assignments). * He can perform an operation only when it is among his assigned items. * + * @property Item[] $children All child items of this item. This property is read-only. * @property string $name The item name. * * @author Qiang Xue diff --git a/framework/yii/rbac/Manager.php b/framework/yii/rbac/Manager.php index 23ac1a8..3d3aafc 100644 --- a/framework/yii/rbac/Manager.php +++ b/framework/yii/rbac/Manager.php @@ -33,9 +33,9 @@ use yii\base\InvalidParamException; * at appropriate places in the application code to check if the current user * has the needed permission for an operation. * - * @property array $roles Roles (name => Item). - * @property array $tasks Tasks (name => Item). - * @property array $operations Operations (name => Item). + * @property Item[] $operations Operations (name => AuthItem). This property is read-only. + * @property Item[] $roles Roles (name => AuthItem). This property is read-only. + * @property Item[] $tasks Tasks (name => AuthItem). This property is read-only. * * @author Qiang Xue * @author Alexander Kochetov diff --git a/framework/yii/rbac/PhpManager.php b/framework/yii/rbac/PhpManager.php index 3808541..203b17e 100644 --- a/framework/yii/rbac/PhpManager.php +++ b/framework/yii/rbac/PhpManager.php @@ -23,7 +23,7 @@ use yii\base\InvalidParamException; * (for example, the authorization data for a personal blog system). * Use [[DbManager]] for more complex authorization data. * - * @property array $authItems The authorization items of the specific type. + * @property Item[] $items The authorization items of the specific type. This property is read-only. * * @author Qiang Xue * @author Alexander Kochetov diff --git a/framework/yii/validators/FileValidator.php b/framework/yii/validators/FileValidator.php index 44e6cd2..4487eee 100644 --- a/framework/yii/validators/FileValidator.php +++ b/framework/yii/validators/FileValidator.php @@ -13,7 +13,7 @@ use yii\web\UploadedFile; /** * FileValidator verifies if an attribute is receiving a valid uploaded file. * - * @property integer $sizeLimit The size limit for uploaded files. + * @property integer $sizeLimit The size limit for uploaded files. This property is read-only. * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/web/Application.php b/framework/yii/web/Application.php index 1a00846..c0b8793 100644 --- a/framework/yii/web/Application.php +++ b/framework/yii/web/Application.php @@ -13,12 +13,12 @@ use yii\base\InvalidRouteException; /** * Application is the base class for all application classes. * - * @property AssetManager $assetManager The asset manager component. + * @property AssetManager $assetManager The asset manager component. This property is read-only. * @property string $homeUrl The homepage URL. - * @property Request $request The request component. - * @property Response $response The response component. - * @property Session $session The session component. - * @property User $user The user component. + * @property Request $request The request component. This property is read-only. + * @property Response $response The response component. This property is read-only. + * @property Session $session The session component. This property is read-only. + * @property User $user The user component. This property is read-only. * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/web/CacheSession.php b/framework/yii/web/CacheSession.php index bb04cff..bb387e1 100644 --- a/framework/yii/web/CacheSession.php +++ b/framework/yii/web/CacheSession.php @@ -21,7 +21,7 @@ use yii\base\InvalidConfigException; * may be swapped out and get lost. Therefore, you must make sure the cache used by this component * is NOT volatile. If you want to use database as storage medium, use [[DbSession]] is a better choice. * - * @property boolean $useCustomStorage Whether to use custom storage. + * @property boolean $useCustomStorage Whether to use custom storage. This property is read-only. * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/web/CookieCollection.php b/framework/yii/web/CookieCollection.php index 9384d31..6940493 100644 --- a/framework/yii/web/CookieCollection.php +++ b/framework/yii/web/CookieCollection.php @@ -15,8 +15,9 @@ use yii\base\Object; /** * CookieCollection maintains the cookies available in the current request. * - * @property integer $count The number of cookies in the collection. - * @property ArrayIterator $iterator An iterator for traversing the cookies in the collection. + * @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. * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/web/DbSession.php b/framework/yii/web/DbSession.php index 3d6b204..c508bb8 100644 --- a/framework/yii/web/DbSession.php +++ b/framework/yii/web/DbSession.php @@ -28,7 +28,7 @@ use yii\base\InvalidConfigException; * ) * ~~~ * - * @property boolean $useCustomStorage Whether to use custom storage. + * @property boolean $useCustomStorage Whether to use custom storage. This property is read-only. * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/web/HeaderCollection.php b/framework/yii/web/HeaderCollection.php index b0b422a..609058b 100644 --- a/framework/yii/web/HeaderCollection.php +++ b/framework/yii/web/HeaderCollection.php @@ -14,8 +14,9 @@ use ArrayIterator; /** * HeaderCollection is used by [[Response]] to maintain the currently registered HTTP headers. * - * @property integer $count The number of headers in the collection. - * @property ArrayIterator $iterator An iterator for traversing the headers in the collection. + * @property integer $count The number of headers in the collection. This property is read-only. + * @property ArrayIterator $iterator An iterator for traversing the headers in the collection. This property + * is read-only. * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/web/Request.php b/framework/yii/web/Request.php index 3833dd7..55073a2 100644 --- a/framework/yii/web/Request.php +++ b/framework/yii/web/Request.php @@ -13,45 +13,49 @@ use yii\helpers\Security; /** * - * @property string $absoluteUrl The currently requested absolute URL. - * @property string $acceptTypes User browser accept types, null if not present. + * @property string $absoluteUrl The currently requested absolute URL. This property is read-only. + * @property string $acceptTypes User browser accept types, null if not present. This property is read-only. * @property array $acceptedContentTypes The content types ordered by the preference level. The first element * represents the most preferred content type. * @property array $acceptedLanguages The languages ordered by the preference level. The first element * represents the most preferred language. * @property string $baseUrl The relative URL for the application. - * @property string $cookieValidationKey The secret key used for cookie validation. If it was not set previously, - * a random key will be generated and used. - * @property CookieCollection $cookies The cookie collection. - * @property string $csrfToken The random token for CSRF validation. - * @property string $hostInfo Schema and hostname part (with port number if needed) of the request URL (e.g. `http://www.yiiframework.com`). - * @property boolean $isAjax Whether this is an AJAX (XMLHttpRequest) request. - * @property boolean $isDelete Whether this is a DELETE request. - * @property boolean $isFlash Whether this is an Adobe Flash or Adobe Flex request. - * @property boolean $isPatch Whether this is a PATCH request. - * @property boolean $isPost Whether this is a POST request. - * @property boolean $isPut Whether this is a PUT request. - * @property boolean $isSecureConnection If the request is sent via secure channel (https). - * @property string $method Request method, such as GET, POST, HEAD, PUT, PATCH, DELETE. - * The value returned is turned into upper case. - * @property string $pathInfo Part of the request URL that is after the entry script and before the question mark. - * Note, the returned path info is already URL-decoded. + * @property string $cookieValidationKey The secret key used for cookie validation. If it was not set + * previously, a random key will be generated and used. + * @property CookieCollection $cookies The cookie collection. This property is read-only. + * @property string $csrfToken The random token for CSRF validation. This property is read-only. + * @property string $hostInfo Schema and hostname part (with port number if needed) of the request URL (e.g. + * `http://www.yiiframework.com`). + * @property boolean $isAjax Whether this is an AJAX (XMLHttpRequest) request. This property is read-only. + * @property boolean $isDelete Whether this is a DELETE request. This property is read-only. + * @property boolean $isFlash Whether this is an Adobe Flash or Adobe Flex request. This property is + * read-only. + * @property boolean $isPatch Whether this is a PATCH request. This property is read-only. + * @property boolean $isPost Whether this is a POST request. This property is read-only. + * @property boolean $isPut Whether this is a PUT request. This property is read-only. + * @property boolean $isSecureConnection If the request is sent via secure channel (https). This property is + * read-only. + * @property string $method Request method, such as GET, POST, HEAD, PUT, PATCH, DELETE. The value returned is + * turned into upper case. This property is read-only. + * @property string $pathInfo Part of the request URL that is after the entry script and before the question + * mark. Note, the returned path info is already URL-decoded. * @property integer $port Port number for insecure requests. - * @property string $preferredLanguage The language that the application should use. Null is returned if both [[getAcceptedLanguages()]] - * and `$languages` are empty. - * @property string $queryString Part of the request URL that is after the question mark. - * @property string $rawBody The request body. - * @property string $referrer URL referrer, null if not present. + * @property string $preferredLanguage The language that the application should use. Null is returned if both + * [[getAcceptedLanguages()]] and `$languages` are empty. This property is read-only. + * @property string $queryString Part of the request URL that is after the question mark. This property is + * read-only. + * @property string $rawBody The request body. This property is read-only. + * @property string $referrer URL referrer, null if not present. This property is read-only. * @property array $restParams The RESTful request parameters. * @property string $scriptFile The entry script file path. * @property string $scriptUrl The relative URL of the entry script. * @property integer $securePort Port number for secure requests. - * @property string $serverName Server name. - * @property integer $serverPort Server port number. + * @property string $serverName Server name. This property is read-only. + * @property integer $serverPort Server port number. This property is read-only. * @property string $url The currently requested relative URL. Note that the URI returned is URL-encoded. - * @property string $userAgent User agent, null if not present. - * @property string $userHost User host name, null if cannot be determined. - * @property string $userIP User IP address. + * @property string $userAgent User agent, null if not present. This property is read-only. + * @property string $userHost User host name, null if cannot be determined. This property is read-only. + * @property string $userIP User IP address. This property is read-only. * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/web/Response.php b/framework/yii/web/Response.php index fb7ee65..286a0db 100644 --- a/framework/yii/web/Response.php +++ b/framework/yii/web/Response.php @@ -18,18 +18,22 @@ use yii\helpers\StringHelper; /** * - * @property CookieCollection $cookies The cookie collection. - * @property HeaderCollection $headers The header collection. - * @property boolean $isClientError Whether this response indicates a client error. - * @property boolean $isEmpty Whether this response is empty. - * @property boolean $isForbidden Whether this response indicates the current request is forbidden. - * @property boolean $isInformational Whether this response is informational. - * @property boolean $isInvalid Whether this response has a valid [[statusCode]]. - * @property boolean $isNotFound Whether this response indicates the currently requested resource is not found. - * @property boolean $isOk Whether this response is OK. - * @property boolean $isRedirection Whether this response is a redirection. - * @property boolean $isServerError Whether this response indicates a server error. - * @property boolean $isSuccessful Whether this response is successful. + * @property CookieCollection $cookies The cookie collection. This property is read-only. + * @property HeaderCollection $headers The header collection. This property is read-only. + * @property boolean $isClientError Whether this response indicates a client error. This property is + * read-only. + * @property boolean $isEmpty Whether this response is empty. This property is read-only. + * @property boolean $isForbidden Whether this response indicates the current request is forbidden. This + * property is read-only. + * @property boolean $isInformational Whether this response is informational. This property is read-only. + * @property boolean $isInvalid Whether this response has a valid [[statusCode]]. This property is read-only. + * @property boolean $isNotFound Whether this response indicates the currently requested resource is not + * found. This property is read-only. + * @property boolean $isOk Whether this response is OK. This property is read-only. + * @property boolean $isRedirection Whether this response is a redirection. This property is read-only. + * @property boolean $isServerError Whether this response indicates a server error. This property is + * read-only. + * @property boolean $isSuccessful Whether this response is successful. This property is read-only. * @property integer $statusCode The HTTP status code to send with the response. * * @author Qiang Xue diff --git a/framework/yii/web/Session.php b/framework/yii/web/Session.php index df98448..fc9fe16 100644 --- a/framework/yii/web/Session.php +++ b/framework/yii/web/Session.php @@ -45,23 +45,27 @@ use yii\base\InvalidParamException; * useful for displaying confirmation messages. To use flash messages, simply * call methods such as [[setFlash()]], [[getFlash()]]. * - * @property array $allFlashes Flash messages (key => message). + * @property array $allFlashes Flash messages (key => message). This property is read-only. * @property array $cookieParams The session cookie parameters. - * @property integer $count The number of session variables. - * @property string $flash The key identifying the flash message. Note that flash messages - * and normal session variables share the same name space. If you have a normal - * session variable using the same name, its value will be overwritten by this method. - * @property float $gCProbability The probability (percentage) that the GC (garbage collection) process is started on every session initialization, defaults to 1 meaning 1% chance. + * @property integer $count The number of session variables. This property is read-only. + * @property string $flash The key identifying the flash message. Note that flash messages and normal session + * variables share the same name space. If you have a normal session variable using the same name, its value will + * be overwritten by this method. This property is write-only. + * @property float $gCProbability The probability (percentage) that the GC (garbage collection) process is + * started on every session initialization, defaults to 1 meaning 1% chance. * @property string $id The current session ID. - * @property boolean $isActive Whether the session has started. - * @property SessionIterator $iterator An iterator for traversing the session variables. + * @property boolean $isActive Whether the session has started. This property is read-only. + * @property SessionIterator $iterator An iterator for traversing the session variables. This property is + * read-only. * @property string $name The current session name. * @property string $savePath The current session save path, defaults to '/tmp'. * @property integer $timeout The number of seconds after which data will be seen as 'garbage' and cleaned up. * The default value is 1440 seconds (or the value of "session.gc_maxlifetime" set in php.ini). - * @property boolean|null $useCookies The value indicating whether cookies should be used to store session IDs. - * @property boolean $useCustomStorage Whether to use custom storage. - * @property boolean $useTransparentSessionID Whether transparent sid support is enabled or not, defaults to false. + * @property boolean|null $useCookies The value indicating whether cookies should be used to store session + * IDs. + * @property boolean $useCustomStorage Whether to use custom storage. This property is read-only. + * @property boolean $useTransparentSessionID Whether transparent sid support is enabled or not, defaults to + * false. * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/web/UploadedFile.php b/framework/yii/web/UploadedFile.php index 82116bd..609388f 100644 --- a/framework/yii/web/UploadedFile.php +++ b/framework/yii/web/UploadedFile.php @@ -11,17 +11,16 @@ use yii\helpers\Html; /** * - * @property integer $error The error code. - * @property boolean $hasError Whether there is an error with the uploaded file. - * Check [[error]] for detailed error code information. - * @property string $name The original name of the file being uploaded. - * @property integer $size The actual size of the uploaded file in bytes. - * @property string $tempName The path of the uploaded file on the server. - * Note, this is a temporary file which will be automatically deleted by PHP - * after the current request is processed. - * @property string $type The MIME-type of the uploaded file (such as "image/gif"). - * Since this MIME type is not checked on the server side, do not take this value for granted. - * Instead, use [[FileHelper::getMimeType()]] to determine the exact MIME type. + * @property integer $error The error code. This property is read-only. + * @property boolean $hasError Whether there is an error with the uploaded file. Check [[error]] for detailed + * error code information. This property is read-only. + * @property string $name The original name of the file being uploaded. This property is read-only. + * @property integer $size The actual size of the uploaded file in bytes. This property is read-only. + * @property string $tempName The path of the uploaded file on the server. Note, this is a temporary file + * which will be automatically deleted by PHP after the current request is processed. This property is read-only. + * @property string $type The MIME-type of the uploaded file (such as "image/gif"). Since this MIME type is + * not checked on the server side, do not take this value for granted. Instead, use [[FileHelper::getMimeType()]] + * to determine the exact MIME type. This property is read-only. * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/web/UrlManager.php b/framework/yii/web/UrlManager.php index 071c5eb..0d9547f 100644 --- a/framework/yii/web/UrlManager.php +++ b/framework/yii/web/UrlManager.php @@ -15,7 +15,8 @@ use yii\caching\Cache; * UrlManager handles HTTP request parsing and creation of URLs based on a set of rules. * * @property string $baseUrl The base URL that is used by [[createUrl()]] to prepend URLs it creates. - * @property string $hostInfo The host info (e.g. "http://www.example.com") that is used by [[createAbsoluteUrl()]] to prepend URLs it creates. + * @property string $hostInfo The host info (e.g. "http://www.example.com") that is used by + * [[createAbsoluteUrl()]] to prepend URLs it creates. * * @author Qiang Xue * @since 2.0 diff --git a/framework/yii/web/User.php b/framework/yii/web/User.php index bae78ec..cfdafd9 100644 --- a/framework/yii/web/User.php +++ b/framework/yii/web/User.php @@ -21,9 +21,10 @@ use yii\base\InvalidConfigException; * the actual user authentication logic and is often backed by a user database table. * * @property string|integer $id The unique identifier for the user. If null, it means the user is a guest. - * @property Identity $identity The identity object associated with the currently logged user. - * Null is returned if the user is not logged in (not authenticated). - * @property boolean $isGuest Whether the current user is a guest. + * This property is read-only. + * @property Identity $identity The identity object associated with the currently logged user. Null is + * returned if the user is not logged in (not authenticated). + * @property boolean $isGuest Whether the current user is a guest. This property is read-only. * @property string $returnUrl The URL that the user should be redirected to after login. * * @author Qiang Xue diff --git a/framework/yii/widgets/FragmentCache.php b/framework/yii/widgets/FragmentCache.php index f67eff3..3f4027b 100644 --- a/framework/yii/widgets/FragmentCache.php +++ b/framework/yii/widgets/FragmentCache.php @@ -14,7 +14,8 @@ use yii\caching\Dependency; /** * - * @property string|boolean $cachedContent The cached content. False is returned if valid content is not found in the cache. + * @property string|boolean $cachedContent The cached content. False is returned if valid content is not found + * in the cache. This property is read-only. * * @author Qiang Xue * @since 2.0