Fix #20658: Add missing generics in yii\console, yii\captcha, yii\caching and yii\behaviors namespaces

mspirkov · web-flow · commit ffa0dda20492 · 2025-10-30T23:41:32.000+03:00
diff --git a/framework/CHANGELOG.md b/framework/CHANGELOG.md
@@ -77,6 +77,7 @@ Yii Framework 2 Change Log
 - Enh #20650: Add PHPStan/Psalm annotations for `yii\di\Container` (mspirkov)
 - Bug #20654: Add missing generics in `yii\db` namespace. Fix PHPDoc annotations in `yii\db\ArrayExpression` (mspirkov)
 - Bug #20651: Add missing generics in `yii\filters` namespace (mspirkov)
+- Bug #20658: Add missing generics in `yii\console`, `yii\captcha`, `yii\caching` and `yii\behaviors` namespaces (mspirkov)
 - Bug #20659: Fix `PHP` `8.5` `null` array offset deprecation warnings in `MariaDB` driver (terabytesoftw)
 
 
diff --git a/framework/base/Behavior.php b/framework/base/Behavior.php
@@ -21,9 +21,6 @@
  * @since 2.0
  *
  * @template T of Component
- *
- * @phpstan-property T|null $owner
- * @psalm-property T|null $owner
  */
 class Behavior extends BaseObject
 {
diff --git a/framework/behaviors/AttributeBehavior.php b/framework/behaviors/AttributeBehavior.php
@@ -11,6 +11,7 @@
 use yii\base\Behavior;
 use yii\base\Event;
 use yii\db\ActiveRecord;
+use yii\db\BaseActiveRecord;
 
 /**
  * AttributeBehavior automatically assigns a specified value to one or multiple attributes of an ActiveRecord
@@ -47,6 +48,9 @@
  * @author Luciano Baraglia <luciano.baraglia@gmail.com>
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @since 2.0
+ *
+ * @template T of BaseActiveRecord
+ * @extends Behavior<T>
  */
 class AttributeBehavior extends Behavior
 {
diff --git a/framework/behaviors/AttributeTypecastBehavior.php b/framework/behaviors/AttributeTypecastBehavior.php
@@ -108,6 +108,9 @@
  *
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0.10
+ *
+ * @template T of Model|BaseActiveRecord
+ * @extends Behavior<T>
  */
 class AttributeTypecastBehavior extends Behavior
 {
@@ -117,7 +120,10 @@ class AttributeTypecastBehavior extends Behavior
     public const TYPE_STRING = 'string';
 
     /**
-     * @var Model|BaseActiveRecord the owner of this behavior.
+     * @var Model|BaseActiveRecord|null the owner of this behavior.
+     *
+     * @phpstan-var T|null
+     * @psalm-var T|null
      */
     public $owner;
     /**
diff --git a/framework/behaviors/AttributesBehavior.php b/framework/behaviors/AttributesBehavior.php
@@ -11,6 +11,7 @@
 use yii\base\Behavior;
 use yii\base\Event;
 use yii\db\ActiveRecord;
+use yii\db\BaseActiveRecord;
 
 /**
  * AttributesBehavior automatically assigns values specified to one or multiple attributes of an ActiveRecord
@@ -60,6 +61,9 @@
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @author Bogdan Stepanenko <bscheshirwork@gmail.com>
  * @since 2.0.13
+ *
+ * @template T of BaseActiveRecord
+ * @extends Behavior<T>
  */
 class AttributesBehavior extends Behavior
 {
diff --git a/framework/behaviors/BlameableBehavior.php b/framework/behaviors/BlameableBehavior.php
@@ -53,6 +53,9 @@
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @author Alexander Kochetov <creocoder@gmail.com>
  * @since 2.0
+ *
+ * @template T of BaseActiveRecord
+ * @extends AttributeBehavior<T>
  */
 class BlameableBehavior extends AttributeBehavior
 {
diff --git a/framework/behaviors/CacheableWidgetBehavior.php b/framework/behaviors/CacheableWidgetBehavior.php
@@ -43,6 +43,9 @@
  *
  * @author Nikolay Oleynikov <oleynikovny@mail.ru>
  * @since 2.0.14
+ *
+ * @template T of Widget
+ * @extends Behavior<Widget>
  */
 class CacheableWidgetBehavior extends Behavior
 {
diff --git a/framework/behaviors/OptimisticLockBehavior.php b/framework/behaviors/OptimisticLockBehavior.php
@@ -61,6 +61,9 @@
  * @author Salem Ouerdani <tunecino@gmail.com>
  * @since 2.0.16
  * @see \yii\db\BaseActiveRecord::optimisticLock() for details on how to enable optimistic lock.
+ *
+ * @template T of BaseActiveRecord
+ * @extends AttributeBehavior<T>
  */
 class OptimisticLockBehavior extends AttributeBehavior
 {
diff --git a/framework/behaviors/SluggableBehavior.php b/framework/behaviors/SluggableBehavior.php
@@ -60,6 +60,9 @@
  * @author Alexander Kochetov <creocoder@gmail.com>
  * @author Paul Klimov <klimov.paul@gmail.com>
  * @since 2.0
+ *
+ * @template T of BaseActiveRecord
+ * @extends AttributeBehavior<T>
  */
 class SluggableBehavior extends AttributeBehavior
 {
diff --git a/framework/behaviors/TimestampBehavior.php b/framework/behaviors/TimestampBehavior.php
@@ -68,6 +68,9 @@
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @author Alexander Kochetov <creocoder@gmail.com>
  * @since 2.0
+ *
+ * @template T of BaseActiveRecord
+ * @extends AttributeBehavior<T>
  */
 class TimestampBehavior extends AttributeBehavior
 {
diff --git a/framework/caching/CacheInterface.php b/framework/caching/CacheInterface.php
@@ -39,6 +39,8 @@
  * @author Qiang Xue <qiang.xue@gmail.com>
  * @author Dmitry Naumenko <d.naumenko.a@gmail.com>
  * @since 2.0.13. Previous framework versions used abstract class [[yii\caching\Cache]] as interface.
+ *
+ * @extends \ArrayAccess<string, mixed>
  */
 interface CacheInterface extends \ArrayAccess
 {
diff --git a/framework/captcha/CaptchaValidator.php b/framework/captcha/CaptchaValidator.php
@@ -12,6 +12,7 @@
 use yii\helpers\Json;
 use yii\validators\ValidationAsset;
 use yii\validators\Validator;
+use yii\web\Controller;
 
 /**
  * CaptchaValidator validates that the attribute value is the same as the verification code displayed in the CAPTCHA.
@@ -67,14 +68,20 @@ protected function validateValue($value)
      * Creates the CAPTCHA action object from the route specified by [[captchaAction]].
      * @return CaptchaAction the action object
      * @throws InvalidConfigException
+     *
+     * @phpstan-return CaptchaAction<Controller>
+     * @psalm-return CaptchaAction<Controller>
      */
     public function createCaptchaAction()
     {
         $ca = Yii::$app->createController($this->captchaAction);
         if ($ca !== false) {
-            /** @var \yii\base\Controller $controller */
+            /** @var Controller $controller */
             list($controller, $actionID) = $ca;
-            /** @var CaptchaAction|null */
+            /**
+             * @var CaptchaAction|null
+             * @phpstan-var CaptchaAction<Controller>|null
+             */
             $action = $controller->createAction($actionID);
             if ($action !== null) {
                 return $action;
diff --git a/framework/console/Controller.php b/framework/console/Controller.php
@@ -545,6 +545,9 @@ public function getHelp()
      * Returns a one-line short summary describing the specified action.
      * @param Action $action action to get summary for
      * @return string a one-line short summary describing the specified action.
+     *
+     * @phpstan-param Action<static> $action
+     * @psalm-param Action<static> $action
      */
     public function getActionHelpSummary($action)
     {
@@ -559,6 +562,9 @@ public function getActionHelpSummary($action)
      * Returns the detailed help information for the specified action.
      * @param Action $action action to get help for
      * @return string the detailed help information for the specified action.
+     *
+     * @phpstan-param Action<static> $action
+     * @psalm-param Action<static> $action
      */
     public function getActionHelp($action)
     {
@@ -581,6 +587,9 @@ public function getActionHelp($action)
      *
      * @param Action $action the action instance
      * @return array the help information of the action arguments
+     *
+     * @phpstan-param Action<static> $action
+     * @psalm-param Action<static> $action
      */
     public function getActionArgsHelp($action)
     {
@@ -654,6 +663,9 @@ public function getActionArgsHelp($action)
      *
      * @param Action $action
      * @return array the help information of the action options
+     *
+     * @phpstan-param Action<static> $action
+     * @psalm-param Action<static> $action
      */
     public function getActionOptionsHelp($action)
     {
@@ -709,6 +721,9 @@ public function getActionOptionsHelp($action)
     /**
      * @param Action $action
      * @return \ReflectionFunctionAbstract
+     *
+     * @phpstan-param Action<static> $action
+     * @psalm-param Action<static> $action
      */
     protected function getActionMethodReflection($action)
     {
@@ -727,6 +742,9 @@ protected function getActionMethodReflection($action)
      * Parses the comment block into tags.
      * @param \ReflectionClass|\ReflectionProperty|\ReflectionFunctionAbstract $reflection the comment block
      * @return array the parsed tags
+     *
+     * @phpstan-param \ReflectionClass<object>|\ReflectionProperty|\ReflectionFunctionAbstract $reflection
+     * @psalm-param \ReflectionClass<object>|\ReflectionProperty|\ReflectionFunctionAbstract $reflection
      */
     protected function parseDocCommentTags($reflection)
     {
@@ -755,6 +773,9 @@ protected function parseDocCommentTags($reflection)
      *
      * @param \ReflectionClass|\ReflectionProperty|\ReflectionFunctionAbstract $reflection
      * @return string
+     *
+     * @phpstan-param \ReflectionClass<$this>|\ReflectionProperty|\ReflectionFunctionAbstract $reflection
+     * @psalm-param \ReflectionClass<$this>|\ReflectionProperty|\ReflectionFunctionAbstract $reflection
      */
     protected function parseDocCommentSummary($reflection)
     {
@@ -771,6 +792,9 @@ protected function parseDocCommentSummary($reflection)
      *
      * @param \ReflectionClass|\ReflectionProperty|\ReflectionFunctionAbstract $reflection
      * @return string
+     *
+     * @phpstan-param \ReflectionClass<$this>|\ReflectionProperty|\ReflectionFunctionAbstract $reflection
+     * @psalm-param \ReflectionClass<$this>|\ReflectionProperty|\ReflectionFunctionAbstract $reflection
      */
     protected function parseDocCommentDetail($reflection)
     {
diff --git a/framework/console/controllers/BaseMigrateController.php b/framework/console/controllers/BaseMigrateController.php
@@ -8,6 +8,7 @@
 namespace yii\console\controllers;
 
 use Yii;
+use yii\base\Action;
 use yii\base\BaseObject;
 use yii\base\InvalidConfigException;
 use yii\base\NotSupportedException;
@@ -122,9 +123,12 @@ public function options($actionID)
     /**
      * This method is invoked right before an action is to be executed (after all possible filters.)
      * It checks the existence of the [[migrationPath]].
-     * @param \yii\base\Action $action the action to be executed.
+     * @param Action $action the action to be executed.
      * @throws InvalidConfigException if directory specified in migrationPath doesn't exist and action isn't "create".
      * @return bool whether the action should continue to be executed.
+     *
+     * @phpstan-param Action<static> $action
+     * @psalm-param Action<static> $action
      */
     public function beforeAction($action)
     {
diff --git a/framework/console/controllers/MigrateController.php b/framework/console/controllers/MigrateController.php
@@ -8,6 +8,7 @@
 namespace yii\console\controllers;
 
 use Yii;
+use yii\base\Action;
 use yii\db\Connection;
 use yii\db\Query;
 use yii\di\Instance;
@@ -174,8 +175,11 @@ public function optionAliases()
     /**
      * This method is invoked right before an action is to be executed (after all possible filters.)
      * It checks the existence of the [[migrationPath]].
-     * @param \yii\base\Action $action the action to be executed.
+     * @param Action $action the action to be executed.
      * @return bool whether the action should continue to be executed.
+     *
+     * @phpstan-param Action<static> $action
+     * @psalm-param Action<static> $action
      */
     public function beforeAction($action)
     {
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -351,27 +351,12 @@ parameters:
 			path: framework/console/Controller.php
 
 		-
-			message: "#^Call to an undefined method yii\\\\base\\\\Component\\:\\:isAttributeChanged\\(\\)\\.$#"
-			count: 1
-			path: framework/behaviors/SluggableBehavior.php
-
-		-
-			message: "#^Call to an undefined method yii\\\\base\\\\Component\\:\\:formName\\(\\)\\.$#"
-			count: 1
-			path: framework/behaviors/OptimisticLockBehavior.php
-
-		-
-			message: "#^Access to an undefined property yii\\\\base\\\\Component\\:\\:\\$view\\.$#"
-			count: 2
-			path: framework/behaviors/CacheableWidgetBehavior.php
-
-		-
-			message: "#^Call to an undefined method yii\\\\base\\\\Model\\:\\:canSetOldAttribute\\(\\)\\.$#"
+			message: "#^Call to an undefined method T of yii\\\\base\\\\Model\\:\\:canSetOldAttribute\\(\\)\\.$#"
 			count: 1
 			path: framework/behaviors/AttributeTypecastBehavior.php
 
 		-
-			message: "#^Call to an undefined method yii\\\\base\\\\Model\\:\\:setOldAttribute\\(\\)\\.$#"
+			message: "#^Call to an undefined method T of yii\\\\base\\\\Model\\:\\:setOldAttribute\\(\\)\\.$#"
 			count: 1
 			path: framework/behaviors/AttributeTypecastBehavior.php
 

Original file line number	Diff line number	Diff line change
`@@ -21,9 +21,6 @@`
`21`	`21`	`* @since 2.0`
`22`	`22`	`*`
`23`	`23`	`* @template T of Component`
`24`		`- *`
`25`		`- * @phpstan-property T\|null $owner`
`26`		`- * @psalm-property T\|null $owner`
`27`	`24`	`*/`
`28`	`25`	`class Behavior extends BaseObject`
`29`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,9 @@`
`43`	`43`	`*`
`44`	`44`	`* @author Nikolay Oleynikov <oleynikovny@mail.ru>`
`45`	`45`	`* @since 2.0.14`
	`46`	`+ *`
	`47`	`+ * @template T of Widget`
	`48`	`+ * @extends Behavior<Widget>`
`46`	`49`	`*/`
`47`	`50`	`class CacheableWidgetBehavior extends Behavior`
`48`	`51`	`{`