#26: Add Sniff for Getters not change state

Author: Lars Roettig

Magento/Sniffs/Functions/GetterStateSniff.php

@@ -74,7 +74,19 @@ public function process(File $phpcsFile, $stackPtr)
             }
 
             if ($isObjectScope === true && array_key_exists($token['code'], Tokens::$assignmentTokens)) {
-                $phpcsFile->addWarning($this->warningMessage, $i, $this->warningCode);
+
+                $isWrappedByIf = false;
+                // Detect if the property warped by an if tag.
+                $ifTag = $phpcsFile->findPrevious(T_IF, $i);
+                if ($ifTag !== false) {
+                    $open = $tokens[$ifTag]['scope_opener'];
+                    $close = $tokens[$ifTag]['scope_closer'];
+                    $isWrappedByIf = $open <= $i && $close >= $i;
+                }
+
+                if ($isWrappedByIf === false) {
+                    $phpcsFile->addWarning($this->warningMessage, $i, $this->warningCode);
+                }
             }
         }
     }

Magento/Tests/Functions/GetterStateUnitTest.inc

@@ -3,9 +3,9 @@
 namespace Foo\Bar;
 
 
-abstract class Bar{
-
-    public static $foobar  = 100;
+abstract class Bar
+{
+    public static $foobar = 100;
 }
 
 class Foo extends Bar
@@ -36,11 +36,27 @@ class Foo extends Bar
      */
     public function getProperty()
     {
+        if (true) {
+
+        }
+
         $this->property = 1223;
         return $this->property;
     }
 
-    public function TestigetFoo()
+    /**
+     * @return int
+     */
+    public function getPropertyCached()
+    {
+        if ($this->property === null) {
+            $this->property = 1223;
+        }
+
+        return $this->property;
+    }
+
+    public function testigetFoo()
     {
         $this->property = 1223;
         return $this->property;

Magento/Tests/Functions/GetterStateUnitTest.php

@@ -30,7 +30,7 @@ protected function getWarningList()
             28 => 1,
             29 => 1,
             30 => 1,
-            39 => 1,
+            43 => 1,
         ];
     }
 }