Update Magento to be compatible with PHP 8.0

karyna-t · andrewbess · commit 2a400852ae2c · 2021-09-12T23:05:44.000+03:00
diff --git a/app/bootstrap.php b/app/bootstrap.php
@@ -30,6 +30,16 @@
     exit(1);
 }
 
+// PHP 8 compatibility. Define constants that are not present in PHP < 8.0
+if (!defined('PHP_VERSION_ID') || PHP_VERSION_ID < 80000) {
+    if (!defined('T_NAME_QUALIFIED')) {
+        define('T_NAME_QUALIFIED', 24001);
+    }
+    if (!defined('T_NAME_FULLY_QUALIFIED')) {
+        define('T_NAME_FULLY_QUALIFIED', 24002);
+    }
+}
+
 require_once __DIR__ . '/autoload.php';
 // Sets default autoload mappings, may be overridden in Bootstrap::create
 \Magento\Framework\App\Bootstrap::populateAutoloader(BP, []);
diff --git a/dev/tests/integration/testsuite/Magento/Customer/Model/ResourceModel/Grid/CollectionReindexOnAccountLockTest.php b/dev/tests/integration/testsuite/Magento/Customer/Model/ResourceModel/Grid/CollectionReindexOnAccountLockTest.php
@@ -12,7 +12,6 @@
 use Magento\Framework\Exception\NoSuchEntityException;
 use Magento\TestFramework\Helper\Bootstrap;
 use Magento\TestFramework\Indexer\TestCase;
-use Magento\Tests\NamingConvention\true\mixed;
 
 /**
  * Test if customer account lock on too many failed authentication attempts triggers customer grid reindex
@@ -39,7 +38,7 @@ private function lockCustomerAccountWithInvalidAuthentications()
     }
 
     /**
-     * @return mixed
+     * @return string|null
      * @throws NoSuchEntityException
      */
     private function getCustomerLockExpire(): ?string
@@ -53,7 +52,7 @@ private function getCustomerLockExpire(): ?string
     }
 
     /**
-     * @return mixed
+     * @return string|null
      */
     private function getCustomerGridLockExpire(): ?string
     {
diff --git a/dev/tests/unit/framework/bootstrap.php b/dev/tests/unit/framework/bootstrap.php
@@ -30,7 +30,8 @@ function setCustomErrorHandler()
 {
     set_error_handler(
         function ($errNo, $errStr, $errFile, $errLine) {
-            if (error_reporting()) {
+            $errLevel = error_reporting();
+            if (($errLevel & $errNo) !== 0) {
                 $errorNames = [
                     E_ERROR => 'Error',
                     E_WARNING => 'Warning',
diff --git a/lib/internal/Magento/Framework/Code/Reader/ClassReader.php b/lib/internal/Magento/Framework/Code/Reader/ClassReader.php
@@ -66,6 +66,10 @@ public function getConstructor($className)
     private function getParameterClass(ReflectionParameter $reflectionParameter): ?ReflectionClass
     {
         $parameterType = $reflectionParameter->getType();
+        // In PHP8, $parameterType could be an instance of ReflectionUnionType, which doesn't have isBuiltin method.
+        if ($parameterType !== null && method_exists($parameterType, 'isBuiltin') === false) {
+            return null;
+        }
 
         return $parameterType && !$parameterType->isBuiltin()
             ? new ReflectionClass($parameterType->getName())
diff --git a/lib/internal/Magento/Framework/Code/Reader/NamespaceResolver.php b/lib/internal/Magento/Framework/Code/Reader/NamespaceResolver.php
@@ -86,6 +86,7 @@ public function getImportedNamespaces(array $fileContent)
         $classStart = array_search('{', $fileContent);
         $fileContent = array_slice($fileContent, 0, $classStart);
         $output = [];
+
         foreach ($fileContent as $position => $token) {
             if (is_array($token) && $token[0] === T_USE) {
                 $import = array_slice($fileContent, $position);
@@ -104,8 +105,14 @@ public function getImportedNamespaces(array $fileContent)
                     $import = array_filter(
                         $import,
                         function ($token) {
-                            $whitelist = [T_NS_SEPARATOR, T_STRING, T_AS];
-                            if (isset($token[0]) && in_array($token[0], $whitelist)) {
+                            $whitelist = [
+                                T_NS_SEPARATOR => T_NS_SEPARATOR,
+                                T_STRING => T_STRING,
+                                T_AS => T_AS,
+                                T_NAME_QUALIFIED => T_NAME_QUALIFIED,
+                                T_NAME_FULLY_QUALIFIED => T_NAME_FULLY_QUALIFIED
+                            ];
+                            if (isset($token[0]) && \array_key_exists($token[0], $whitelist)) {
                                 return true;
                             }
                             return false;
diff --git a/lib/internal/Magento/Framework/DB/AbstractMapper.php b/lib/internal/Magento/Framework/DB/AbstractMapper.php
@@ -125,7 +125,7 @@ public function map(CriteriaInterface $criteria)
                 if (!is_array($value)) {
                     throw new \InvalidArgumentException('Wrong type of argument, expecting array for '. $mapperMethod);
                 }
-                call_user_func_array([$this, $mapperMethod], $value);
+                call_user_func_array([$this, $mapperMethod], array_values($value));
             }
         }
         return $this->select;
diff --git a/lib/internal/Magento/Framework/Escaper.php b/lib/internal/Magento/Framework/Escaper.php
@@ -303,6 +303,11 @@ public function encodeUrlParam($string)
      */
     public function escapeJs($string)
     {
+        if (!is_string($string) && !is_array($string)) {
+            // In PHP > 8, preg_replace_callback throws an error if the 3rd param type is incorrect.
+            // This check emulates an old behavior.
+            return $string;
+        }
         if ($string === '' || ctype_digit($string)) {
             return $string;
         }
diff --git a/lib/internal/Magento/Framework/MessageQueue/Rpc/Publisher.php b/lib/internal/Magento/Framework/MessageQueue/Rpc/Publisher.php
@@ -55,18 +55,12 @@ class Publisher implements PublisherInterface
      *
      * @param ExchangeRepository $exchangeRepository
      * @param EnvelopeFactory $envelopeFactory
-     * @param null $messageQueueConfig @deprecated obsolete dependency
-     * @param null $amqpConfig @deprecated obsolete dependency
      * @param MessageEncoder $messageEncoder
      * @param MessageValidator $messageValidator
-     *
-     * @SuppressWarnings(PHPMD.UnusedFormalParameter)
      */
     public function __construct(
         ExchangeRepository $exchangeRepository,
         EnvelopeFactory $envelopeFactory,
-        $messageQueueConfig = null,
-        $amqpConfig = null,
         MessageEncoder $messageEncoder,
         MessageValidator $messageValidator
     ) {
diff --git a/lib/internal/Magento/Framework/Model/AbstractModel.php b/lib/internal/Magento/Framework/Model/AbstractModel.php
@@ -186,7 +186,7 @@ public function __construct(
         $this->_logger = $context->getLogger();
         $this->_actionValidator = $context->getActionValidator();
 
-        if (method_exists($this->_resource, 'getIdFieldName')
+        if ((($this->_resource !== null) && (method_exists($this->_resource, 'getIdFieldName')))
             || $this->_resource instanceof \Magento\Framework\DataObject
         ) {
             $this->_idFieldName = $this->_getResource()->getIdFieldName();
diff --git a/lib/internal/Magento/Framework/Translate.php b/lib/internal/Magento/Framework/Translate.php
@@ -332,6 +332,8 @@ protected function _addData($data)
                 continue;
             }
 
+            $key = is_array($key) ? $key : (string) $key;
+            $value = is_array($value) ? $value : (string) $value;
             $key = str_replace('""', '"', $key);
             $value = str_replace('""', '"', $value);
 
diff --git a/lib/internal/Magento/Framework/View/Layout/Generator/Block.php b/lib/internal/Magento/Framework/View/Layout/Generator/Block.php
@@ -299,7 +299,7 @@ protected function generateAction($block, $methodName, $actionArguments)
         $profilerKey = 'BLOCK_ACTION:' . $block->getNameInLayout() . '>' . $methodName;
         \Magento\Framework\Profiler::start($profilerKey);
         $args = $this->evaluateArguments($actionArguments);
-        call_user_func_array([$block, $methodName], $args);
+        call_user_func_array([$block, $methodName], array_values($args));
         \Magento\Framework\Profiler::stop($profilerKey);
     }
 
diff --git a/setup/src/Magento/Setup/Console/CompilerPreparation.php b/setup/src/Magento/Setup/Console/CompilerPreparation.php
@@ -140,7 +140,7 @@ private function shouldInvalidateCompiledDI(): bool
                     function ($matches) {
                         return preg_quote($matches[1]) . '[^:]*';
                     },
-                    $cmdName
+                    ($cmdName ?? '')
                 );
                 $commands = preg_grep('{^' . $expr . '$}', $compilationCommands);
                 if (empty($commands)) {
diff --git a/setup/src/Magento/Setup/Module/Di/Code/Reader/FileClassScanner.php b/setup/src/Magento/Setup/Module/Di/Code/Reader/FileClassScanner.php
@@ -15,7 +15,10 @@ class FileClassScanner
     private const NAMESPACE_TOKENS = [
         T_WHITESPACE => true,
         T_STRING => true,
-        T_NS_SEPARATOR => true
+        T_NS_SEPARATOR => true,
+        // PHP 8 compatibility.
+        T_NAME_QUALIFIED => true,
+        T_NAME_FULLY_QUALIFIED => true,
     ];
 
     private const ALLOWED_OPEN_BRACES_TOKENS = [
@@ -109,6 +112,7 @@ private function extract(): string
         $triggerNamespace = false;
         $braceLevel = 0;
         $bracedNamespace = false;
+        $namespace = '';
 
         // phpcs:ignore
         $this->tokens = token_get_all($this->getFileContents());
@@ -146,6 +150,15 @@ private function extract(): string
                     $namespaceParts = [];
                     $bracedNamespace = $this->isBracedNamespace($index);
                     break;
+
+                // PHP 8
+                case T_NAME_QUALIFIED:
+                case T_NAME_FULLY_QUALIFIED:
+                    if ($triggerNamespace) {
+                        $namespace = $token[1];
+                    }
+                    break;
+
                 case T_TRAIT:
                 case T_CLASS:
                     // Current loop contains the class keyword. Next loop will have the class name itself.
@@ -157,7 +170,8 @@ private function extract(): string
 
             // We have a class name, let's concatenate and return it!
             if ($class !== '') {
-                $fqClassName = trim(implode('', $namespaceParts)) . trim($class);
+                $fqClassName = $namespace ? (trim($namespace) . '\\' . trim($class))
+                    : (trim(implode('', $namespaceParts)) . trim($class));
                 return $fqClassName;
             }
         }
diff --git a/setup/src/Magento/Setup/Module/Di/Code/Reader/FileScanner.php b/setup/src/Magento/Setup/Module/Di/Code/Reader/FileScanner.php
@@ -81,13 +81,12 @@ protected function scan()
             define('T_TRAIT', 42001);
         }
 
-        // ensure php backwards compatibility (from laminas code 3.5.x)
-        if (!defined('T_NAME_QUALIFIED')) {
-            define('T_NAME_QUALIFIED', 24001);
-        }
-        if (!defined('T_NAME_FULLY_QUALIFIED')) {
-            define('T_NAME_FULLY_QUALIFIED', 24002);
-        }
+        $namespaceContentTokenTypes = [
+            T_NS_SEPARATOR => T_NS_SEPARATOR,
+            T_STRING => T_STRING,
+            T_NAME_QUALIFIED => T_NAME_QUALIFIED,
+            T_NAME_FULLY_QUALIFIED => T_NAME_FULLY_QUALIFIED
+        ];
 
         /**
          * Variables & Setup
@@ -206,8 +205,7 @@ protected function scan()
                 if ($this->tokenType === T_WHITESPACE) {
                     goto SCANNER_NAMESPACE_CONTINUE;
                 }
-
-                if ($this->tokenType === T_NS_SEPARATOR || $this->tokenType === T_STRING) {
+                if (\array_key_exists($this->tokenType, $namespaceContentTokenTypes)) {
                     $infos[$infoIndex]['namespace'] .= $tokenContent;
                 }
 
@@ -264,7 +262,7 @@ protected function scan()
                         goto SCANNER_USE_CONTINUE;
                     }
 
-                    if ($this->tokenType == T_NS_SEPARATOR || $this->tokenType == T_STRING) {
+                    if (\array_key_exists($this->tokenType, $namespaceContentTokenTypes)) {
                         if ($useAsContext == false) {
                             $infos[$infoIndex]['statements'][$useStatementIndex]['use'] .= $tokenContent;
                         } else {
diff --git a/setup/src/Magento/Setup/Module/Di/Code/Scanner/PhpScanner.php b/setup/src/Magento/Setup/Module/Di/Code/Scanner/PhpScanner.php
@@ -197,16 +197,29 @@ public function collectEntities(array $files)
      */
     protected function _fetchNamespace($tokenIterator, $count, $tokens)
     {
-        $namespaceParts = [];
-        for ($tokenOffset = $tokenIterator + 1; $tokenOffset < $count; ++$tokenOffset) {
-            if ($tokens[$tokenOffset][0] === T_STRING) {
-                $namespaceParts[] = "\\";
-                $namespaceParts[] = $tokens[$tokenOffset][1];
-            } elseif ($tokens[$tokenOffset] === '{' || $tokens[$tokenOffset] === ';') {
+        if (version_compare(PHP_VERSION, '8.0') < 0) {
+            $namespaceParts = [];
+            for ($tokenOffset = $tokenIterator + 1; $tokenOffset < $count; ++$tokenOffset) {
+                if ($tokens[$tokenOffset][0] === T_STRING) {
+                    $namespaceParts[] = "\\";
+                    $namespaceParts[] = $tokens[$tokenOffset][1];
+                } elseif ($tokens[$tokenOffset] === '{' || $tokens[$tokenOffset] === ';') {
+                    break;
+                }
+            }
+            return join('', $namespaceParts);
+        }
+
+        $namespace = '';
+        for ($tokenOffset = ($tokenIterator + 1); $tokenOffset < $count; ++$tokenOffset) {
+            if ($tokens[$tokenOffset][0] === T_NAME_QUALIFIED) {
+                $namespace = $tokens[$tokenOffset][1];
+            } else if ($tokens[$tokenOffset] === '{' || $tokens[$tokenOffset] === ';') {
                 break;
             }
         }
-        return join('', $namespaceParts);
+
+        return $namespace;
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -125,7 +125,7 @@ public function map(CriteriaInterface $criteria)`
`125`	`125`	`if (!is_array($value)) {`
`126`	`126`	`throw new \InvalidArgumentException('Wrong type of argument, expecting array for '. $mapperMethod);`
`127`	`127`	`}`
`128`		`- call_user_func_array([$this, $mapperMethod], $value);`
	`128`	`+ call_user_func_array([$this, $mapperMethod], array_values($value));`
`129`	`129`	`}`
`130`	`130`	`}`
`131`	`131`	`return $this->select;`
Original file line number	Diff line number	Diff line change
`@@ -303,6 +303,11 @@ public function encodeUrlParam($string)`
`303`	`303`	`*/`
`304`	`304`	`public function escapeJs($string)`
`305`	`305`	`{`
	`306`	`+ if (!is_string($string) && !is_array($string)) {`
	`307`	`+ // In PHP > 8, preg_replace_callback throws an error if the 3rd param type is incorrect.`
	`308`	`+ // This check emulates an old behavior.`
	`309`	`+ return $string;`
	`310`	`+ }`
`306`	`311`	`if ($string === '' \|\| ctype_digit($string)) {`
`307`	`312`	`return $string;`
`308`	`313`	`}`
Original file line number	Diff line number	Diff line change
`@@ -332,6 +332,8 @@ protected function _addData($data)`
`332`	`332`	`continue;`
`333`	`333`	`}`
`334`	`334`
	`335`	`+ $key = is_array($key) ? $key : (string) $key;`
	`336`	`+ $value = is_array($value) ? $value : (string) $value;`
`335`	`337`	`$key = str_replace('""', '"', $key);`
`336`	`338`	`$value = str_replace('""', '"', $value);`
`337`	`339`