yiisoft / yii2

framework/db/Migration.php

Doc Comments +8 added lines, -8 removed lines

@@ -86,7 +86,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()
@@ -115,7 +115,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()
@@ -155,7 +155,7 @@ 
      * be enclosed within a DB transaction.
      * Child classes may implement this method instead of [[up()]] if the DB logic
      * needs to be within a transaction.
-     * @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()
@@ -168,7 +168,7 @@ 
      * be enclosed within a DB transaction.
      * Child classes may implement this method instead of [[down()]] if the DB logic
      * needs to be within a transaction.
-     * @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()
@@ -387,7 +387,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)
     {
@@ -415,9 +415,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
      */
@@ -446,7 +446,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/db/Query.php

Doc Comments +2 added lines, -2 removed lines

@@ -768,7 +768,7 @@ 
 
     /**
      * Sets the GROUP BY part of the query.
-     * @param string|array|Expression $columns the columns to be grouped by.
+     * @param string $columns the columns to be grouped by.
      * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']).
      * The method will automatically quote the column names unless a column contains some parenthesis
      * (which means the column contains a DB expression).
@@ -967,7 +967,7 @@ 
 
     /**
      * Appends a SQL statement using UNION operator.
-     * @param string|Query $sql the SQL statement to be appended using UNION
+     * @param Query $sql the SQL statement to be appended using UNION
      * @param bool $all TRUE if using UNION ALL and FALSE if using UNION
      * @return $this the query object itself
      */

framework/captcha/CaptchaAction.php

Doc Comments +1 added lines, -1 removed lines

@@ -144,7 +144,7 @@
     /**
      * Generates a hash code that can be used for client-side validation.
      * @param string $code the CAPTCHA code
-     * @return string a hash code generated from the CAPTCHA code
+     * @return integer a hash code generated from the CAPTCHA code
      */
     public function generateValidationHash($code)
     {

framework/db/ActiveQuery.php

Doc Comments +1 added lines, -1 removed lines

@@ -392,7 +392,7 @@
      * @param bool|array $eagerLoading whether to eager load the relations specified in `$with`.
      * When this is a boolean, it applies to all relations specified in `$with`. Use an array
      * to explicitly list which relations in `$with` need to be eagerly loaded. Defaults to `true`.
-     * @param string|array $joinType the join type of the relations specified in `$with`.
+     * @param string $joinType the join type of the relations specified in `$with`.
      * When this is a string, it applies to all relations specified in `$with`. Use an array
      * in the format of `relationName => joinType` to specify different join types for different relations.
      * @return $this the query object itself

framework/db/DataReader.php

Doc Comments +1 added lines, -1 removed lines

@@ -114,7 +114,7 @@
     /**
      * Returns a single column from the next row of a result set.
      * @param int $columnIndex zero-based column index
-     * @return mixed the column of the current row, false if no more rows available
+     * @return string the column of the current row, false if no more rows available
      */
     public function readColumn($columnIndex)
     {

framework/helpers/BaseHtml.php

Doc Comments +2 added lines, -2 removed lines

@@ -208,7 +208,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,
@@ -1854,7 +1854,7 @@ 
      * ```
      *
      * @param array $options the options to be modified.
-     * @param string|array $class the CSS class(es) to be added
+     * @param string $class the CSS class(es) to be added
      */
     public static function addCssClass(&$options, $class)
     {

framework/web/Response.php

Doc Comments +1 added lines, -1 removed lines

@@ -789,7 +789,7 @@
      * });
      * ```
      *
-     * @param string|array $url the URL to be redirected to. This can be in one of the following formats:
+     * @param string $url the URL to be redirected to. This can be in one of the following formats:
      *
      * - a string representing a URL (e.g. "http://example.com")
      * - a string representing a URL alias (e.g. "@example.com")

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/BaseFileHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -636,7 +636,7 @@
      * @param string $pattern
      * @param bool $caseSensitive
      * @throws \yii\base\InvalidArgumentException
-     * @return array with keys: (string) pattern, (int) flags, (int|bool) firstWildcard
+     * @return string with keys: (string) pattern, (int) flags, (int|bool) firstWildcard
      */
     private static function parseExcludePattern($pattern, $caseSensitive)
     {