From 1a9b4a48285cc913e648d8f6c8b877e51b87fde8 Mon Sep 17 00:00:00 2001
From: "andrii.zinkevych" <a.zinkevych@atwix.com>
Date: Fri, 5 Nov 2021 11:14:46 +0100
Subject: [PATCH 1/3] Created Sniff to validate function without argument

---
 .../Functions/DeprecatedFunctionSniff.php     | 64 +++++++++++++++++++
 .../Functions/DeprecatedFunctionUnitTest.inc  | 32 ++++++++++
 .../Functions/DeprecatedFunctionUnitTest.php  | 38 +++++++++++
 Magento2/ruleset.xml                          |  5 ++
 4 files changed, 139 insertions(+)
 create mode 100644 Magento2/Sniffs/Functions/DeprecatedFunctionSniff.php
 create mode 100644 Magento2/Tests/Functions/DeprecatedFunctionUnitTest.inc
 create mode 100644 Magento2/Tests/Functions/DeprecatedFunctionUnitTest.php

diff --git a/Magento2/Sniffs/Functions/DeprecatedFunctionSniff.php b/Magento2/Sniffs/Functions/DeprecatedFunctionSniff.php
new file mode 100644
index 00000000..c573b8e5
--- /dev/null
+++ b/Magento2/Sniffs/Functions/DeprecatedFunctionSniff.php
@@ -0,0 +1,64 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento2\Sniffs\Functions;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+/**
+ * Sniff to validate PHP deprecated function.
+ */
+class DeprecatedFunctionSniff implements Sniff
+{
+    /**
+     * Deprecated functions without argument.
+     *
+     * @var array
+     */
+    private $deprecatedFunctions = [
+        'mb_check_encoding'
+    ];
+
+    /**
+     * @inheritdoc
+     */
+    public function register(): array
+    {
+        return [
+            T_OPEN_TAG
+        ];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function process(File $phpcsFile, $stackPtr): void
+    {
+        $tokens = $phpcsFile->getTokens();
+
+        foreach ($this->deprecatedFunctions as $deprecatedFunction) {
+            $deprecatedFunctionKeys = array_keys(array_column($tokens, 'content'), $deprecatedFunction);
+
+            foreach ($deprecatedFunctionKeys as $deprecatedFunctionKey) {
+                $openParenthesis = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $deprecatedFunctionKey);
+                $closeParenthesis = $phpcsFile->findNext(T_CLOSE_PARENTHESIS, $openParenthesis);
+                $argumentString = trim(
+                    $phpcsFile->getTokensAsString($openParenthesis + 1, $closeParenthesis - $openParenthesis - 1)
+                );
+
+                if (!$argumentString) {
+                    $warningMessage = sprintf(
+                        'Calling function %s() without argument is deprecated in PHP 8.1',
+                        $deprecatedFunction
+                    );
+                    $phpcsFile->addWarning($warningMessage, $deprecatedFunctionKey, 'DeprecatedFunction');
+                }
+            }
+        }
+    }
+}
diff --git a/Magento2/Tests/Functions/DeprecatedFunctionUnitTest.inc b/Magento2/Tests/Functions/DeprecatedFunctionUnitTest.inc
new file mode 100644
index 00000000..08465f2a
--- /dev/null
+++ b/Magento2/Tests/Functions/DeprecatedFunctionUnitTest.inc
@@ -0,0 +1,32 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento2\Tests\Functions;
+
+/**
+ * Class to test PHP deprecated function.
+ */
+class DeprecatedFunction
+{
+    /**
+     * Test deprecation function.
+     *
+     * @return bool
+     */
+    public function testDeprecatedMethod(): bool
+    {
+        // Warning: function is deprecated without argument.
+        $testMethodParam = mb_check_encoding();
+
+        if ($testMethodParam) {
+            // The function is work correct.
+            $testMethodParam = mb_check_encoding('test-argument', null);
+        }
+
+        return $testMethodParam;
+    }
+}
diff --git a/Magento2/Tests/Functions/DeprecatedFunctionUnitTest.php b/Magento2/Tests/Functions/DeprecatedFunctionUnitTest.php
new file mode 100644
index 00000000..263b8491
--- /dev/null
+++ b/Magento2/Tests/Functions/DeprecatedFunctionUnitTest.php
@@ -0,0 +1,38 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento2\Tests\Functions;
+
+use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
+
+/**
+ * Sniff to validate PHP deprecated function.
+ */
+class DeprecatedFunctionUnitTest extends AbstractSniffUnitTest
+{
+    /**
+     * @inheritdoc
+     */
+    public function getErrorList(): array
+    {
+        return [];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function getWarningList($testFile = ''): array
+    {
+        if ($testFile === 'DeprecatedFunctionUnitTest.inc') {
+            return [
+                23 => 1
+            ];
+        }
+
+        return [];
+    }
+}
diff --git a/Magento2/ruleset.xml b/Magento2/ruleset.xml
index 5ea68ff3..1a19e962 100644
--- a/Magento2/ruleset.xml
+++ b/Magento2/ruleset.xml
@@ -251,6 +251,11 @@
         <exclude-pattern>*Test.php</exclude-pattern>
         <exclude-pattern>*/tests/*</exclude-pattern>
     </rule>
+    <rule ref="Magento2.Functions.DeprecatedFunction">
+        <severity>7</severity>
+        <type>warning</type>
+        <exclude-pattern>*\.xml$</exclude-pattern>
+    </rule>
     <rule ref="Magento2.Namespaces.ImportsFromTestNamespace">
         <severity>8</severity>
         <type>warning</type>

From c8957167a3c4cfbc3de08a1311145253e2e76e78 Mon Sep 17 00:00:00 2001
From: "andrii.zinkevych" <a.zinkevych@atwix.com>
Date: Fri, 5 Nov 2021 14:51:57 +0100
Subject: [PATCH 2/3] Fixed code by recommendation

---
 .../Functions/DeprecatedFunctionSniff.php     | 64 ----------------
 ...unctionsDeprecatedWithoutArgumentSniff.php | 73 +++++++++++++++++++
 .../Functions/DeprecatedFunctionUnitTest.inc  | 32 --------
 ...tionsDeprecatedWithoutArgumentUnitTest.inc | 33 +++++++++
 ...ionsDeprecatedWithoutArgumentUnitTest.php} | 19 +++--
 Magento2/ruleset.xml                          |  2 +-
 6 files changed, 116 insertions(+), 107 deletions(-)
 delete mode 100644 Magento2/Sniffs/Functions/DeprecatedFunctionSniff.php
 create mode 100644 Magento2/Sniffs/Functions/FunctionsDeprecatedWithoutArgumentSniff.php
 delete mode 100644 Magento2/Tests/Functions/DeprecatedFunctionUnitTest.inc
 create mode 100644 Magento2/Tests/Functions/FunctionsDeprecatedWithoutArgumentUnitTest.inc
 rename Magento2/Tests/Functions/{DeprecatedFunctionUnitTest.php => FunctionsDeprecatedWithoutArgumentUnitTest.php} (55%)

diff --git a/Magento2/Sniffs/Functions/DeprecatedFunctionSniff.php b/Magento2/Sniffs/Functions/DeprecatedFunctionSniff.php
deleted file mode 100644
index c573b8e5..00000000
--- a/Magento2/Sniffs/Functions/DeprecatedFunctionSniff.php
+++ /dev/null
@@ -1,64 +0,0 @@
-<?php
-/**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
-declare(strict_types=1);
-
-namespace Magento2\Sniffs\Functions;
-
-use PHP_CodeSniffer\Files\File;
-use PHP_CodeSniffer\Sniffs\Sniff;
-
-/**
- * Sniff to validate PHP deprecated function.
- */
-class DeprecatedFunctionSniff implements Sniff
-{
-    /**
-     * Deprecated functions without argument.
-     *
-     * @var array
-     */
-    private $deprecatedFunctions = [
-        'mb_check_encoding'
-    ];
-
-    /**
-     * @inheritdoc
-     */
-    public function register(): array
-    {
-        return [
-            T_OPEN_TAG
-        ];
-    }
-
-    /**
-     * @inheritdoc
-     */
-    public function process(File $phpcsFile, $stackPtr): void
-    {
-        $tokens = $phpcsFile->getTokens();
-
-        foreach ($this->deprecatedFunctions as $deprecatedFunction) {
-            $deprecatedFunctionKeys = array_keys(array_column($tokens, 'content'), $deprecatedFunction);
-
-            foreach ($deprecatedFunctionKeys as $deprecatedFunctionKey) {
-                $openParenthesis = $phpcsFile->findNext(T_OPEN_PARENTHESIS, $deprecatedFunctionKey);
-                $closeParenthesis = $phpcsFile->findNext(T_CLOSE_PARENTHESIS, $openParenthesis);
-                $argumentString = trim(
-                    $phpcsFile->getTokensAsString($openParenthesis + 1, $closeParenthesis - $openParenthesis - 1)
-                );
-
-                if (!$argumentString) {
-                    $warningMessage = sprintf(
-                        'Calling function %s() without argument is deprecated in PHP 8.1',
-                        $deprecatedFunction
-                    );
-                    $phpcsFile->addWarning($warningMessage, $deprecatedFunctionKey, 'DeprecatedFunction');
-                }
-            }
-        }
-    }
-}
diff --git a/Magento2/Sniffs/Functions/FunctionsDeprecatedWithoutArgumentSniff.php b/Magento2/Sniffs/Functions/FunctionsDeprecatedWithoutArgumentSniff.php
new file mode 100644
index 00000000..13d53fc3
--- /dev/null
+++ b/Magento2/Sniffs/Functions/FunctionsDeprecatedWithoutArgumentSniff.php
@@ -0,0 +1,73 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento2\Sniffs\Functions;
+
+use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Sniffs\Sniff;
+
+/**
+ * Sniff to validate PHP functions usage of which without passing arguments is deprecated.
+ */
+class FunctionsDeprecatedWithoutArgumentSniff implements Sniff
+{
+    /**
+     * String representation of warning.
+     *
+     * @var string
+     */
+    private $warningMessage = 'Calling function %s() without argument is deprecated in PHP 8.1. '
+        . 'Please pass the input to validate as the first argument of the function.';
+
+    /**
+     * Warning violation code.
+     *
+     * @var string
+     */
+    private $warningCode = 'FunctionsDeprecatedWithoutArgument';
+
+    /**
+     * Deprecated functions without argument.
+     *
+     * @var array
+     */
+    private $deprecatedFunctions = [
+        'mb_check_encoding',
+        'get_class',
+        'get_parent_class',
+        'get_called_class'
+    ];
+
+    /**
+     * @inheritdoc
+     */
+    public function register(): array
+    {
+        return [
+            T_OPEN_PARENTHESIS
+        ];
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function process(File $phpcsFile, $stackPtr): void
+    {
+        $closeParenthesisPtr = $phpcsFile->findNext(T_CLOSE_PARENTHESIS, $stackPtr);
+        $arguments = trim($phpcsFile->getTokensAsString($stackPtr + 1, $closeParenthesisPtr - $stackPtr - 1));
+
+        if ($arguments) {
+            return;
+        }
+
+        $functionName = $phpcsFile->getTokensAsString($phpcsFile->findPrevious(T_STRING, $stackPtr), 1);
+
+        if (in_array($functionName, $this->deprecatedFunctions)) {
+            $phpcsFile->addWarning(sprintf($this->warningMessage, $functionName), $stackPtr, $this->warningCode);
+        }
+    }
+}
diff --git a/Magento2/Tests/Functions/DeprecatedFunctionUnitTest.inc b/Magento2/Tests/Functions/DeprecatedFunctionUnitTest.inc
deleted file mode 100644
index 08465f2a..00000000
--- a/Magento2/Tests/Functions/DeprecatedFunctionUnitTest.inc
+++ /dev/null
@@ -1,32 +0,0 @@
-<?php
-/**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
-declare(strict_types=1);
-
-namespace Magento2\Tests\Functions;
-
-/**
- * Class to test PHP deprecated function.
- */
-class DeprecatedFunction
-{
-    /**
-     * Test deprecation function.
-     *
-     * @return bool
-     */
-    public function testDeprecatedMethod(): bool
-    {
-        // Warning: function is deprecated without argument.
-        $testMethodParam = mb_check_encoding();
-
-        if ($testMethodParam) {
-            // The function is work correct.
-            $testMethodParam = mb_check_encoding('test-argument', null);
-        }
-
-        return $testMethodParam;
-    }
-}
diff --git a/Magento2/Tests/Functions/FunctionsDeprecatedWithoutArgumentUnitTest.inc b/Magento2/Tests/Functions/FunctionsDeprecatedWithoutArgumentUnitTest.inc
new file mode 100644
index 00000000..63b449b9
--- /dev/null
+++ b/Magento2/Tests/Functions/FunctionsDeprecatedWithoutArgumentUnitTest.inc
@@ -0,0 +1,33 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento2\Tests\Functions;
+
+/**
+ * Class to test validate PHP functions usage of which without passing arguments.
+ */
+class FunctionsDeprecatedWithoutArgument
+{
+    /**
+     * Test deprecation function.
+     *
+     * @return array
+     */
+    public function testDeprecatedMethod(): array
+    {
+        return [
+            mb_check_encoding(), // Calling without argument is deprecated.
+            mb_check_encoding('test-argument', null),
+            get_class(), // Calling without argument is deprecated.
+            get_class(new FunctionsDeprecatedWithoutArgument()),
+            get_parent_class(), // Calling without argument is deprecated.
+            get_parent_class('test-argument'),
+            get_called_class(), // Calling without argument is deprecated.
+            get_called_class('test-argument')
+        ];
+    }
+}
diff --git a/Magento2/Tests/Functions/DeprecatedFunctionUnitTest.php b/Magento2/Tests/Functions/FunctionsDeprecatedWithoutArgumentUnitTest.php
similarity index 55%
rename from Magento2/Tests/Functions/DeprecatedFunctionUnitTest.php
rename to Magento2/Tests/Functions/FunctionsDeprecatedWithoutArgumentUnitTest.php
index 263b8491..691dd43a 100644
--- a/Magento2/Tests/Functions/DeprecatedFunctionUnitTest.php
+++ b/Magento2/Tests/Functions/FunctionsDeprecatedWithoutArgumentUnitTest.php
@@ -10,9 +10,9 @@
 use PHP_CodeSniffer\Tests\Standards\AbstractSniffUnitTest;
 
 /**
- * Sniff to validate PHP deprecated function.
+ * Test to validate PHP functions usage of which without passing arguments.
  */
-class DeprecatedFunctionUnitTest extends AbstractSniffUnitTest
+class FunctionsDeprecatedWithoutArgumentUnitTest extends AbstractSniffUnitTest
 {
     /**
      * @inheritdoc
@@ -25,14 +25,13 @@ public function getErrorList(): array
     /**
      * @inheritdoc
      */
-    public function getWarningList($testFile = ''): array
+    public function getWarningList(): array
     {
-        if ($testFile === 'DeprecatedFunctionUnitTest.inc') {
-            return [
-                23 => 1
-            ];
-        }
-
-        return [];
+        return [
+            23 => 1,
+            25 => 1,
+            27 => 1,
+            29 => 1
+        ];
     }
 }
diff --git a/Magento2/ruleset.xml b/Magento2/ruleset.xml
index 1a19e962..12114bdb 100644
--- a/Magento2/ruleset.xml
+++ b/Magento2/ruleset.xml
@@ -251,7 +251,7 @@
         <exclude-pattern>*Test.php</exclude-pattern>
         <exclude-pattern>*/tests/*</exclude-pattern>
     </rule>
-    <rule ref="Magento2.Functions.DeprecatedFunction">
+    <rule ref="Magento2.Functions.FunctionsDeprecatedWithoutArgument">
         <severity>7</severity>
         <type>warning</type>
         <exclude-pattern>*\.xml$</exclude-pattern>

From dc7c3f4ff211aaa150d4e6e3bb46b59c62328f6f Mon Sep 17 00:00:00 2001
From: "andrii.zinkevych" <a.zinkevych@atwix.com>
Date: Sun, 7 Nov 2021 17:36:44 +0100
Subject: [PATCH 3/3] Fixed code by recommendation, added constants

---
 .../FunctionsDeprecatedWithoutArgumentSniff.php        | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Magento2/Sniffs/Functions/FunctionsDeprecatedWithoutArgumentSniff.php b/Magento2/Sniffs/Functions/FunctionsDeprecatedWithoutArgumentSniff.php
index 13d53fc3..331e918e 100644
--- a/Magento2/Sniffs/Functions/FunctionsDeprecatedWithoutArgumentSniff.php
+++ b/Magento2/Sniffs/Functions/FunctionsDeprecatedWithoutArgumentSniff.php
@@ -20,7 +20,7 @@ class FunctionsDeprecatedWithoutArgumentSniff implements Sniff
      *
      * @var string
      */
-    private $warningMessage = 'Calling function %s() without argument is deprecated in PHP 8.1. '
+    private const WARNING_MESSAGE = 'Calling function %s() without argument is deprecated in PHP 8.1. '
         . 'Please pass the input to validate as the first argument of the function.';
 
     /**
@@ -28,14 +28,14 @@ class FunctionsDeprecatedWithoutArgumentSniff implements Sniff
      *
      * @var string
      */
-    private $warningCode = 'FunctionsDeprecatedWithoutArgument';
+    private const WARNING_CODE = 'FunctionsDeprecatedWithoutArgument';
 
     /**
      * Deprecated functions without argument.
      *
      * @var array
      */
-    private $deprecatedFunctions = [
+    private const FUNCTIONS_LIST = [
         'mb_check_encoding',
         'get_class',
         'get_parent_class',
@@ -66,8 +66,8 @@ public function process(File $phpcsFile, $stackPtr): void
 
         $functionName = $phpcsFile->getTokensAsString($phpcsFile->findPrevious(T_STRING, $stackPtr), 1);
 
-        if (in_array($functionName, $this->deprecatedFunctions)) {
-            $phpcsFile->addWarning(sprintf($this->warningMessage, $functionName), $stackPtr, $this->warningCode);
+        if (in_array($functionName, self::FUNCTIONS_LIST)) {
+            $phpcsFile->addWarning(sprintf(self::WARNING_MESSAGE, $functionName), $stackPtr, self::WARNING_CODE);
         }
     }
 }