yiisoft / yii2

framework/web/User.php

Doc Comments +2 added lines, -2 removed lines

@@ -175,7 +175,7 @@ 
      * stored in session and reconstruct the corresponding identity object, if it has not done so before.
      * @param bool $autoRenew whether to automatically renew authentication status if it has not been done so before.
      * This is only useful when [[enableSession]] is true.
-     * @return IdentityInterface|null the identity object associated with the currently logged-in user.
+     * @return null|boolean the identity object associated with the currently logged-in user.
      * `null` is returned if the user is not logged in (not authenticated).
      * @see login()
      * @see logout()
@@ -259,7 +259,7 @@ 
      * with the provided access token. If successful, it will call [[login()]] to log in the authenticated user.
      * If authentication fails or [[login()]] is unsuccessful, it will return null.
      * @param string $token the access token
-     * @param mixed $type the type of the token. The value of this parameter depends on the implementation.
+     * @param string $type the type of the token. The value of this parameter depends on the implementation.
      * For example, [[\yii\filters\auth\HttpBearerAuth]] will set this parameter to be `yii\filters\auth\HttpBearerAuth`.
      * @return IdentityInterface|null the identity associated with the given access token. Null is returned if
      * the access token is invalid or [[login()]] is unsuccessful.

framework/helpers/BaseHtml.php

Doc Comments +1 added lines, -1 removed lines

@@ -216,7 +216,7 @@
 
     /**
      * Generates a link tag that refers to an external CSS file.
-     * @param array|string $url the URL of the external CSS file. This parameter will be processed by [[Url::to()]].
+     * @param string|boolean $url the URL of the external CSS file. This parameter will be processed by [[Url::to()]].
      * @param array $options the tag options in terms of name-value pairs. The following options are specially handled:
      *
      * - condition: specifies the conditional comments for IE, e.g., `lt IE 9`. When this is specified,

framework/db/Migration.php

Doc Comments +8 added lines, -8 removed lines

@@ -90,7 +90,7 @@ 
     /**
      * This method contains the logic to be executed when applying this migration.
      * Child classes may override this method to provide actual migration logic.
-     * @return bool return a false value to indicate the migration fails
+     * @return false|null return a false value to indicate the migration fails
      * and should not proceed further. All other return values mean the migration succeeds.
      */
     public function up()
@@ -119,7 +119,7 @@ 
      * This method contains the logic to be executed when removing this migration.
      * The default implementation throws an exception indicating the migration cannot be removed.
      * Child classes may override this method if the corresponding migrations can be removed.
-     * @return bool return a false value to indicate the migration fails
+     * @return false|null return a false value to indicate the migration fails
      * and should not proceed further. All other return values mean the migration succeeds.
      */
     public function down()
@@ -164,7 +164,7 @@ 
      * please refer to [implicit commit](http://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html). If this is the case,
      * you should still implement `up()` and `down()`, instead.
      *
-     * @return bool return a false value to indicate the migration fails
+     * @return boolean|null return a false value to indicate the migration fails
      * and should not proceed further. All other return values mean the migration succeeds.
      */
     public function safeUp()
@@ -182,7 +182,7 @@ 
      * please refer to [implicit commit](http://dev.mysql.com/doc/refman/5.7/en/implicit-commit.html). If this is the case,
      * you should still implement `up()` and `down()`, instead.
      *
-     * @return bool return a false value to indicate the migration fails
+     * @return boolean|null return a false value to indicate the migration fails
      * and should not proceed further. All other return values mean the migration succeeds.
      */
     public function safeDown()
@@ -401,7 +401,7 @@ 
      * The method will properly quote the table and column names.
      * @param string $name the name of the primary key constraint.
      * @param string $table the table that the primary key constraint will be added to.
-     * @param string|array $columns comma separated string or array of columns that the primary key will consist of.
+     * @param string[] $columns comma separated string or array of columns that the primary key will consist of.
      */
     public function addPrimaryKey($name, $table, $columns)
     {
@@ -429,9 +429,9 @@ 
      * The method will properly quote the table and column names.
      * @param string $name the name of the foreign key constraint.
      * @param string $table the table that the foreign key constraint will be added to.
-     * @param string|array $columns the name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas or use an array.
+     * @param string $columns the name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas or use an array.
      * @param string $refTable the table that the foreign key references to.
-     * @param string|array $refColumns the name of the column that the foreign key references to. If there are multiple columns, separate them with commas or use an array.
+     * @param string $refColumns the name of the column that the foreign key references to. If there are multiple columns, separate them with commas or use an array.
      * @param string $delete the ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
      * @param string $update the ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
      */
@@ -460,7 +460,7 @@ 
      * Builds and executes a SQL statement for creating a new index.
      * @param string $name the name of the index. The name will be properly quoted by the method.
      * @param string $table the table that the new index will be created for. The table name will be properly quoted by the method.
-     * @param string|array $columns the column(s) that should be included in the index. If there are multiple columns, please separate them
+     * @param string $columns the column(s) that should be included in the index. If there are multiple columns, please separate them
      * by commas or use an array. Each column name will be properly quoted by the method. Quoting will be skipped for column names that
      * include a left parenthesis "(".
      * @param bool $unique whether to add UNIQUE constraint on the created index.

framework/console/controllers/BaseMigrateController.php

Doc Comments +4 added lines, -4 removed lines

@@ -204,7 +204,7 @@ 
      * yii migrate/down all # revert all migrations
      * ```
      *
-     * @param int|string $limit the number of migrations to be reverted. Defaults to 1,
+     * @param integer $limit the number of migrations to be reverted. Defaults to 1,
      * meaning the last applied migration will be reverted. When value is "all", all migrations will be reverted.
      * @throws Exception if the number of the steps specified is less than 1.
      *
@@ -266,7 +266,7 @@ 
      * yii migrate/redo all # redo all migrations
      * ```
      *
-     * @param int|string $limit the number of migrations to be redone. Defaults to 1,
+     * @param integer $limit the number of migrations to be redone. Defaults to 1,
      * meaning the last applied migration will be redone. When equals "all", all migrations will be redone.
      * @throws Exception if the number of the steps specified is less than 1.
      *
@@ -463,7 +463,7 @@ 
      * yii migrate/history all # showing the whole history
      * ```
      *
-     * @param int|string $limit the maximum number of migrations to be displayed.
+     * @param integer $limit the maximum number of migrations to be displayed.
      * If it is "all", the whole migration history will be displayed.
      * @throws \yii\console\Exception if invalid limit value passed
      */
@@ -507,7 +507,7 @@ 
      * yii migrate/new all # showing all new migrations
      * ```
      *
-     * @param int|string $limit the maximum number of new migrations to be displayed.
+     * @param integer $limit the maximum number of new migrations to be displayed.
      * If it is `all`, all available new migrations will be displayed.
      * @throws \yii\console\Exception if invalid limit value passed
      */

framework/db/pgsql/Schema.php

Doc Comments +1 added lines, -1 removed lines

@@ -266,7 +266,7 @@
     /**
      * Loads the column information into a [[ColumnSchema]] object.
      * @param array $info column information
-     * @return ColumnSchema the column schema object
+     * @return \yii\db\ColumnSchema the column schema object
      */
     protected function loadColumnSchema($info)
     {

framework/base/Application.php

Doc Comments +1 added lines, -1 removed lines

@@ -530,7 +530,7 @@
 
     /**
      * Returns the request component.
-     * @return \yii\web\Request|\yii\console\Request the request component.
+     * @return Request the request component.
      */
     public function getRequest()
     {

framework/db/Command.php

Doc Comments +2 added lines, -2 removed lines

@@ -242,7 +242,7 @@ 
 
     /**
      * Binds a parameter to the SQL statement to be executed.
-     * @param string|int $name parameter identifier. For a prepared statement
+     * @param string $name parameter identifier. For a prepared statement
      * using named placeholders, this will be a parameter name of
      * the form `:name`. For a prepared statement using question mark
      * placeholders, this will be the 1-indexed position of the parameter.
@@ -379,7 +379,7 @@ 
     /**
      * Executes the SQL statement and returns the value of the first column in the first row of data.
      * This method is best used when only a single value is needed for a query.
-     * @return string|null|false the value of the first column in the first row of the query result.
+     * @return string the value of the first column in the first row of the query result.
      * False is returned if there is no value.
      * @throws Exception execution failed
      */

framework/helpers/BaseArrayHelper.php

Doc Comments +4 added lines, -4 removed lines

@@ -446,7 +446,7 @@ 
      * ```
      *
      * @param array $array the array that needs to be indexed or grouped
-     * @param string|\Closure|null $key the column name or anonymous function which result will be used to index the array
+     * @param null|string $key the column name or anonymous function which result will be used to index the array
      * @param string|string[]|\Closure[]|null $groups the array of keys, that will be used to group the input array
      * by one or more keys. If the $key attribute or its value for the particular element is null and $groups is not
      * defined, the array element will be discarded. Otherwise, if $groups is specified, array element will be added
@@ -566,8 +566,8 @@ 
      * ```
      *
      * @param array $array
-     * @param string|\Closure $from
-     * @param string|\Closure $to
+     * @param string $from
+     * @param string $to
      * @param string|\Closure $group
      * @return array
      */
@@ -622,7 +622,7 @@ 
      * To sort by multiple keys, provide an array of keys here.
      * @param int|array $direction the sorting direction. It can be either `SORT_ASC` or `SORT_DESC`.
      * When sorting by multiple keys with different sorting directions, use an array of sorting directions.
-     * @param int|array $sortFlag the PHP sort flag. Valid values include
+     * @param integer $sortFlag the PHP sort flag. Valid values include
      * `SORT_REGULAR`, `SORT_NUMERIC`, `SORT_STRING`, `SORT_LOCALE_STRING`, `SORT_NATURAL` and `SORT_FLAG_CASE`.
      * Please refer to [PHP manual](http://php.net/manual/en/function.sort.php)
      * for more details. When sorting by multiple keys with different sort flags, use an array of sort flags.

build/controllers/PhpDocController.php

Doc Comments +24 added lines, -2 removed lines

@@ -113,6 +113,9 @@ 
         return array_merge(parent::options($actionID), ['updateFiles', 'skipFrameworkRequirements']);
     }
 
+    /**
+     * @param string|null $root
+     */
     protected function findFiles($root, $needsInclude = true)
     {
         $except = [];
@@ -233,6 +236,9 @@ 
         return FileHelper::findFiles($root, $options);
     }
 
+    /**
+     * @param string $extensionPath
+     */
     private function setUpExtensionAliases($extensionPath)
     {
         foreach (scandir($extensionPath) as $extension) {
@@ -340,6 +346,9 @@ 
         }
     }
 
+    /**
+     * @param string $line
+     */
     protected function fixParamTypes($line)
     {
         return preg_replace_callback('~@(param|return) ([\w\\|]+)~i', function ($matches) {
@@ -473,6 +482,10 @@ 
         // TODO
     }
 
+    /**
+     * @param null|string $className
+     * @param string $propertyDoc
+     */
     protected function updateClassPropertyDocs($file, $className, $propertyDoc)
     {
         try {
@@ -553,7 +566,7 @@ 
     /**
      * remove multi empty lines and trim trailing whitespace.
      *
-     * @param $doc
+     * @param string $doc
      * @return string
      */
     protected function cleanDocComment($doc)
@@ -572,7 +585,7 @@ 
 
     /**
      * Replace property annotations in doc comment.
-     * @param $doc
+     * @param string $doc
      * @param $properties
      * @return string
      */
@@ -739,6 +752,9 @@ 
         return [$className, $phpdoc];
     }
 
+    /**
+     * @param string $pattern
+     */
     protected function match($pattern, $subject, $split = false)
     {
         $sets = [];
@@ -762,6 +778,9 @@ 
         return $sets;
     }
 
+    /**
+     * @param string $str
+     */
     protected function fixSentence($str)
     {
         // TODO fix word wrap
@@ -771,6 +790,9 @@ 
         return strtoupper(substr($str, 0, 1)) . substr($str, 1) . ($str[strlen($str) - 1] != '.' ? '.' : '');
     }
 
+    /**
+     * @param string $param
+     */
     protected function getPropParam($prop, $param)
     {
         return isset($prop['property']) ? $prop['property'][$param] : (isset($prop['get']) ? $prop['get'][$param] : $prop['set'][$param]);