Adjust name to reflect also assignment as OK.

Author: dereuromark

README.md

@@ -148,8 +148,8 @@ This rule check if the options (args) passed to Table::find and SelectQuery are
 ### TableGetMatchOptionsTypesRule
 This rule check if the options (args) passed to Table::get are valid find options types.
 
-### ControllerMethodMustReturnRule
-This rule enforces that controller methods like `render()` and `redirect()` must be returned to prevent unreachable code. These methods should always be used with a `return` statement to make the control flow explicit.
+### ControllerMethodMustBeUsedRule
+This rule enforces that controller methods like `render()` and `redirect()` must be used (returned or assigned) to prevent unreachable code. These methods should not be called in void context - use them with a `return` statement or assign them to a variable to make the control flow explicit.
 
 <details>
       <summary>Examples:</summary>
@@ -168,6 +168,14 @@ public function myAction()
     return $this->render('edit');
 }
 
+// Also good - assignment is valid
+public function myAction()
+{
+    $response = $this->render('edit');
+
+    return $response;
+}
+
 // Bad - code after redirect() is unreachable
 public function myAction()
 {

rules.neon

@@ -8,7 +8,7 @@ parameters:
 	 	disallowEntityArrayAccessRule: false
 	 	getMailerExistsClassRule: true
 	 	loadComponentExistsClassRule: true
-	 	controllerMethodMustReturnRule: true
+	 	controllerMethodMustBeUsedRule: true
 parametersSchema:
 	cakeDC: structure([
 		addAssociationExistsTableClassRule: anyOf(bool(), arrayOf(bool()))
@@ -19,16 +19,16 @@ parametersSchema:
 		disallowEntityArrayAccessRule: anyOf(bool(), arrayOf(bool()))
 		getMailerExistsClassRule: anyOf(bool(), arrayOf(bool()))
 		loadComponentExistsClassRule: anyOf(bool(), arrayOf(bool()))
-		controllerMethodMustReturnRule: anyOf(bool(), arrayOf(bool()))
+		controllerMethodMustBeUsedRule: anyOf(bool(), arrayOf(bool()))
 	])
 
 conditionalTags:
 	CakeDC\PHPStan\Visitor\AddAssociationSetClassNameVisitor:
 		phpstan.parser.richParserNodeVisitor: %cakeDC.addAssociationExistsTableClassRule%
 	CakeDC\PHPStan\Rule\Controller\LoadComponentExistsClassRule:
 		phpstan.rules.rule: %cakeDC.loadComponentExistsClassRule%
-	CakeDC\PHPStan\Rule\Controller\ControllerMethodMustReturnRule:
-		phpstan.rules.rule: %cakeDC.controllerMethodMustReturnRule%
+	CakeDC\PHPStan\Rule\Controller\ControllerMethodMustBeUsedRule:
+		phpstan.rules.rule: %cakeDC.controllerMethodMustBeUsedRule%
 	CakeDC\PHPStan\Rule\Model\AddAssociationExistsTableClassRule:
 		phpstan.rules.rule: %cakeDC.addAssociationExistsTableClassRule%
 	CakeDC\PHPStan\Rule\Model\AddAssociationMatchOptionsTypesRule:
@@ -50,7 +50,7 @@ services:
 	-
 		class: CakeDC\PHPStan\Rule\Controller\LoadComponentExistsClassRule
 	-
-		class: CakeDC\PHPStan\Rule\Controller\ControllerMethodMustReturnRule
+		class: CakeDC\PHPStan\Rule\Controller\ControllerMethodMustBeUsedRule
 	-
 		class: CakeDC\PHPStan\Rule\Model\AddAssociationExistsTableClassRule
 	-

src/Rule/Controller/ControllerMethodMustReturnRule.php renamed to src/Rule/Controller/ControllerMethodMustBeUsedRule.php

@@ -22,17 +22,17 @@
 use PHPStan\Rules\RuleErrorBuilder;
 
 /**
- * Rule to enforce that certain controller methods must be returned
- * to prevent unreachable code.
+ * Rule to enforce that certain controller methods must be used
+ * (returned or assigned) to prevent unreachable code.
  */
-class ControllerMethodMustReturnRule implements Rule
+class ControllerMethodMustBeUsedRule implements Rule
 {
     /**
-     * Methods that must be returned
+     * Methods that must be used (returned or assigned)
      *
      * @var array<string>
      */
-    protected array $methodsRequiringReturn = [
+    protected array $methodsRequiringUsage = [
         'render',
         'redirect',
     ];
@@ -67,7 +67,7 @@ public function processNode(Node $node, Scope $scope): array
         }
 
         $methodName = $methodCall->name->toString();
-        if (!in_array($methodName, $this->methodsRequiringReturn, true)) {
+        if (!in_array($methodName, $this->methodsRequiringUsage, true)) {
             return [];
         }
 
@@ -92,14 +92,15 @@ public function processNode(Node $node, Scope $scope): array
         }
 
         // If we reach here, it means the method call is wrapped in an Expression node
-        // which means it's used as a statement (not returned)
+        // which means it's used as a statement (not returned or assigned)
         return [
             RuleErrorBuilder::message(sprintf(
-                'Method %s() must be returned to prevent unreachable code. Use "return $this->%s()" instead.',
+                'Method `%s()` must be used to prevent unreachable code. ' .
+                'Use `return $this->%s()` or assign it to a variable.',
                 $methodName,
                 $methodName,
             ))
-            ->identifier('cake.controller.' . $methodName . 'MustReturn')
+            ->identifier('cake.controller.' . $methodName . 'MustBeUsed')
             ->build(),
         ];
     }

tests/TestCase/Rule/Controller/ControllerMethodMustReturnRuleTest.php renamed to tests/TestCase/Rule/Controller/ControllerMethodMustBeUsedRuleTest.php

@@ -13,18 +13,18 @@
 
 namespace CakeDC\PHPStan\Test\TestCase\Rule\Controller;
 
-use CakeDC\PHPStan\Rule\Controller\ControllerMethodMustReturnRule;
+use CakeDC\PHPStan\Rule\Controller\ControllerMethodMustBeUsedRule;
 use PHPStan\Rules\Rule;
 use PHPStan\Testing\RuleTestCase;
 
-class ControllerMethodMustReturnRuleTest extends RuleTestCase
+class ControllerMethodMustBeUsedRuleTest extends RuleTestCase
 {
     /**
      * @return \PHPStan\Rules\Rule
      */
     protected function getRule(): Rule
     {
-        return new ControllerMethodMustReturnRule();
+        return new ControllerMethodMustBeUsedRule();
     }
 
     /**
@@ -34,19 +34,19 @@ public function testRule(): void
     {
         $this->analyse([__DIR__ . '/Fake/FailingControllerMethodReturnLogic.php'], [
             [
-                'Method render() must be returned to prevent unreachable code. Use "return $this->render()" instead.',
+                'Method `render()` must be used to prevent unreachable code. Use `return $this->render()` or assign it to a variable.',
                 17,
             ],
             [
-                'Method redirect() must be returned to prevent unreachable code. Use "return $this->redirect()" instead.',
+                'Method `redirect()` must be used to prevent unreachable code. Use `return $this->redirect()` or assign it to a variable.',
                 29,
             ],
             [
-                'Method render() must be returned to prevent unreachable code. Use "return $this->render()" instead.',
+                'Method `render()` must be used to prevent unreachable code. Use `return $this->render()` or assign it to a variable.',
                 62,
             ],
             [
-                'Method redirect() must be returned to prevent unreachable code. Use "return $this->redirect()" instead.',
+                'Method `redirect()` must be used to prevent unreachable code. Use `return $this->redirect()` or assign it to a variable.',
                 74,
             ],
         ]);

tests/TestCase/Rule/Controller/Fake/FailingControllerMethodReturnLogic.php

@@ -74,4 +74,28 @@ public function actionWithConditionalRedirectNoReturn()
             $this->redirect(['action' => 'add']);
         }
     }
+
+    /**
+     * Action with render() assigned to variable (valid usage)
+     *
+     * @return \Cake\Http\Response|null
+     */
+    public function actionWithRenderAssigned()
+    {
+        $response = $this->render('edit');
+
+        return $response;
+    }
+
+    /**
+     * Action with redirect() assigned to variable (valid usage)
+     *
+     * @return \Cake\Http\Response|null
+     */
+    public function actionWithRedirectAssigned()
+    {
+        $response = $this->redirect(['action' => 'index']);
+
+        return $response;
+    }
 }