updated phpdoc properties

extensions/apidoc/models/ClassDoc.php

@@ -10,6 +10,8 @@ namespace yii\apidoc\models;
 /**
  * Represents API documentation information for a `class`.
  *
+ * @property EventDoc[] $nativeEvents This property is read-only.
+ *
  * @author Carsten Brandt <mail@cebe.cc>
  * @since 2.0
  */

extensions/apidoc/models/TypeDoc.php

@@ -14,6 +14,13 @@ use yii\helpers\StringHelper;
 /**
  * Base class for API documentation information for classes, interfaces and traits.
  *
+ * @property MethodDoc[] $nativeMethods This property is read-only.
+ * @property PropertyDoc[] $nativeProperties This property is read-only.
+ * @property MethodDoc[] $protectedMethods This property is read-only.
+ * @property PropertyDoc[] $protectedProperties This property is read-only.
+ * @property MethodDoc[] $publicMethods This property is read-only.
+ * @property PropertyDoc[] $publicProperties This property is read-only.
+ *
  * @author Carsten Brandt <mail@cebe.cc>
  * @since 2.0
  */

extensions/apidoc/templates/html/Renderer.php

@@ -30,6 +30,8 @@ use yii\web\View;
 /**
  * The base class for HTML API documentation renderers.
  *
+ * @property View $view The view instance. This property is read-only.
+ *
  * @author Carsten Brandt <mail@cebe.cc>
  * @since 2.0
  */

extensions/apidoc/templates/online/Renderer.php

@@ -56,7 +56,7 @@ class Renderer extends \yii\apidoc\templates\html\Renderer
 		$controller->stdout('done.' . PHP_EOL, Console::FG_GREEN);
 	}
 
-	protected function generateUrl($typeName)
+	public function generateUrl($typeName)
 	{
 		return strtolower(str_replace('\\', '-', $typeName));
 	}

extensions/codeception/BasePage.php

@@ -9,7 +9,7 @@ use yii\base\InvalidConfigException;
 /**
  * BasePage is the base class for page classes that represent Web pages to be tested.
  *
- * @property string $url the URL to this page
+ * @property string $url The URL to this page. This property is read-only.
  *
  * @author Mark Jebri <mark.github@yandex.ru>
  * @since 2.0

extensions/elasticsearch/ActiveRecord.php

@@ -39,6 +39,9 @@ use yii\helpers\StringHelper;
  *
  * You may override [[index()]] and [[type()]] to define the index and type this record represents.
  *
+ * @property float $score Returns the score of this record when it was retrieved via a [[find()]] query. This
+ * property is read-only.
+ *
  * @author Carsten Brandt <mail@cebe.cc>
  * @since 2.0
  */

extensions/faker/FixtureController.php

@@ -131,7 +131,7 @@ use yii\helpers\Console;
  *    ],
  * ~~~
  *
- * @property \Faker\Generator $generator
+ * @property \Faker\Generator $generator This property is read-only.
  *
  * @author Mark Jebri <mark.github@yandex.ru>
  * @since 2.0.0

extensions/gii/CodeFile.php

@@ -10,7 +10,6 @@ namespace yii\gii;
 use Yii;
 use yii\base\Object;
 use yii\gii\components\DiffRendererHtmlInline;
-use yii\gii\components\TextDiff;
 use yii\helpers\Html;
 
 /**

extensions/gii/generators/controller/Generator.php

@@ -15,6 +15,15 @@ use yii\helpers\Inflector;
 /**
  * This generator will generate a controller and one or a few action view files.
  *
+ * @property array $actionIDs An array of action IDs entered by the user. This property is read-only.
+ * @property string $controllerClass The controller class name without the namespace part. This property is
+ * read-only.
+ * @property string $controllerFile The controller class file path. This property is read-only.
+ * @property string $controllerID The controller ID (without the module ID prefix). This property is
+ * read-only.
+ * @property \yii\base\Module $module The module that the new controller belongs to. This property is
+ * read-only.
+ *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @since 2.0
  */

extensions/gii/generators/crud/Generator.php

@@ -17,6 +17,10 @@ use yii\web\Controller;
 
 /**
  *
+ * @property string $controllerID The controller ID (without the module ID prefix). This property is
+ * read-only.
+ * @property string $viewPath The action view file path. This property is read-only.
+ *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @since 2.0
  */

extensions/gii/generators/form/Generator.php

@@ -14,6 +14,8 @@ use yii\gii\CodeFile;
 /**
  * This generator will generate an action view file based on the specified model class.
  *
+ * @property array $modelAttributes List of safe attributes of [[modelClass]]. This property is read-only.
+ *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @since 2.0
  */

extensions/gii/generators/module/Generator.php

@@ -15,6 +15,9 @@ use yii\helpers\StringHelper;
 /**
  * This generator will generate the skeleton code needed by a module.
  *
+ * @property string $controllerNamespace The controller namespace of the module. This property is read-only.
+ * @property boolean $modulePath The directory that contains the module class. This property is read-only.
+ *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @since 2.0
  */

extensions/mongodb/Session.php

@@ -30,6 +30,8 @@ use yii\base\InvalidConfigException;
  * ]
  * ~~~
  *
+ * @property boolean $useCustomStorage Whether to use custom storage. This property is read-only.
+ *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0
  */

framework/base/Controller.php

@@ -12,8 +12,6 @@ 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. 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

framework/helpers/BaseFileHelper.php

@@ -278,14 +278,16 @@ class BaseFileHelper
 			// this should also be done only once
 			if (isset($options['except'])) {
 				foreach($options['except'] as $key=>$value) {
-					if (is_string($value))
+					if (is_string($value)) {
 						$options['except'][$key] = static::parseExcludePattern($value);
+					}
 				}
 			}
 			if (isset($options['only'])) {
 				foreach($options['only'] as $key=>$value) {
-					if (is_string($value))
+					if (is_string($value)) {
 						$options['only'][$key] = static::parseExcludePattern($value);
+					}
 				}
 			}
 		}

framework/log/Logger.php

@@ -66,8 +66,8 @@ use yii\base\Component;
  * 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: `[$token,
- * $category, $time]`. This property is read-only.
+ * @property array $profiling The profiling results. Each element is an array consisting of these elements:
+ * `info`, `category`, `timestamp`, `trace`, `level`, `duration`. This property is read-only.
  *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @since 2.0

framework/test/ActiveFixture.php

@@ -24,6 +24,9 @@ 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()]].
  *
+ * @property TableSchema $tableSchema The schema information of the database table associated with this
+ * fixture. This property is read-only.
+ *
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @since 2.0
  */

framework/web/Request.php

@@ -23,18 +23,21 @@ use yii\helpers\StringHelper;
  * You can access that instance via `Yii::$app->request`.
  *
  * @property string $absoluteUrl The currently requested absolute URL. This property is read-only.
- * @property array $acceptableContentTypes The content types ordered by the preference level. The first element
- * represents the most preferred content type.
+ * @property array $acceptableContentTypes The content types ordered by the preference level. The first
+ * element represents the most preferred content type.
  * @property array $acceptableLanguages 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 array $bodyParams The request parameters given in the request body.
+ * @property string $contentType Request content-type. Null is returned if this information is not available.
+ * This property is read-only.
  * @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 $csrfToken The token used to perform CSRF validation. This property is read-only.
  * @property string $csrfTokenFromHeader The CSRF token sent via [[CSRF_HEADER]] by browser. Null is returned
  * if no such header is sent. This property is read-only.
- * @property array $delete The DELETE request parameter values. This property is read-only.
+ * @property HeaderCollection $headers The header collection. 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.
@@ -49,21 +52,18 @@ use yii\helpers\StringHelper;
  * @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 $rawCsrfToken The unmasked CSRF token sent via cookie. 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 array $patch The PATCH request parameter values. 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 array $post The POST request parameter values. This property is read-only.
- * @property string $preferredLanguage The language that the application should use. This property is read-only.
- * @property array $put The PUT request parameter values. This property is read-only.
+ * @property array $postParams The request POST parameter values.
+ * @property array $queryParams The request GET parameter values.
  * @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 $rawCsrfToken The random token for CSRF validation. 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.

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]].
  *
+ * @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
  * error code information. This property is read-only.
  *