AC-6437:Ensure PHP8.1 Support after 7.4 removal

faizan-shk · faizan-shk · commit f84c7aafa966 · 2022-09-06T00:14:59.000+05:30
- Created Trait GetReflectionMethodReturnTypeValueTrait.php for getting return type value of Reflection Method
	- Fixed static and unit test failures
diff --git a/app/code/Magento/Deploy/Service/DeployStaticFile.php b/app/code/Magento/Deploy/Service/DeployStaticFile.php
@@ -82,6 +82,8 @@ public function __construct(
     }
 
     /**
+     * Deploy static file
+     *
      * @param string $fileName
      * @param array $params ['area' =>, 'theme' =>, 'locale' =>, 'module' =>]
      * @return string
@@ -98,6 +100,8 @@ public function deployFile(string $fileName, array $params = []): string
     }
 
     /**
+     * Delete static file
+     *
      * @param string $path
      * @return void
      * @throws FileSystemException
@@ -138,6 +142,8 @@ public function readFile(string $fileName, string $filePath): bool|string
     }
 
     /**
+     * Open static file
+     *
      * @param string $fileName
      * @param string $filePath
      * @return WriteInterface
diff --git a/app/code/Magento/Deploy/Test/Unit/Service/DeployTranslationsDictionaryTest.php b/app/code/Magento/Deploy/Test/Unit/Service/DeployTranslationsDictionaryTest.php
@@ -76,6 +76,8 @@ function ($checkDictionary, $params) use ($dictionary, $area, $theme, $locale) {
                     $this->assertEquals($area, $params['area']);
                     $this->assertEquals($theme, $params['theme']);
                     $this->assertEquals($locale, $params['locale']);
+
+                    return $dictionary;
                 }
             );
 
diff --git a/lib/internal/Magento/Framework/Async/Code/Generator/ProxyDeferredGenerator.php b/lib/internal/Magento/Framework/Async/Code/Generator/ProxyDeferredGenerator.php
@@ -9,6 +9,7 @@
 
 use Magento\Framework\Async\DeferredInterface;
 use Magento\Framework\Code\Generator\EntityAbstract;
+use Magento\Framework\GetReflectionMethodReturnTypeValueTrait;
 use Magento\Framework\ObjectManager\DefinitionFactory;
 use Magento\Framework\ObjectManager\NoninterceptableInterface;
 
@@ -17,6 +18,8 @@
  */
 class ProxyDeferredGenerator extends EntityAbstract
 {
+    use GetReflectionMethodReturnTypeValueTrait;
+
     /**
      * Entity type
      */
@@ -234,34 +237,4 @@ protected function _validateData()
 
         return $result;
     }
-
-    /**
-     * Returns return type
-     *
-     * @param \ReflectionMethod $method
-     * @return null|string
-     */
-    private function getReturnTypeValue(\ReflectionMethod $method): ?string
-    {
-        $returnTypeValue = null;
-        $returnType = $method->getReturnType();
-        if ($returnType) {
-            if ($returnType instanceof \ReflectionUnionType) {
-                $returnTypeValue = [];
-                foreach ($method->getReturnType()->getTypes() as $type) {
-                    $returnTypeValue[] =  $type->getName();
-                }
-
-                $returnTypeValue = implode('|', $returnTypeValue);
-
-            } else {
-                $returnTypeValue = ($returnType->allowsNull() && $returnType->getName() !== 'mixed' ? '?' : '');
-                $returnTypeValue .= ($returnType->getName() === 'self')
-                    ? $this->_getFullyQualifiedClassName($method->getDeclaringClass()->getName())
-                    : $returnType->getName();
-            }
-        }
-
-        return $returnTypeValue;
-    }
 }
diff --git a/lib/internal/Magento/Framework/GetReflectionMethodReturnTypeValueTrait.php b/lib/internal/Magento/Framework/GetReflectionMethodReturnTypeValueTrait.php
@@ -0,0 +1,44 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Framework;
+
+/**
+ * Returns the return type of reflection method
+ */
+trait GetReflectionMethodReturnTypeValueTrait
+{
+    /**
+     * Returns return type
+     *
+     * @param \ReflectionMethod $method
+     * @return string|null
+     */
+    private function getReturnTypeValue(\ReflectionMethod $method): ?string
+    {
+        $returnTypeValue = null;
+        $returnType = $method->getReturnType();
+        if ($returnType) {
+            if ($returnType instanceof \ReflectionUnionType) {
+                $returnTypeValue = [];
+                foreach ($method->getReturnType()->getTypes() as $type) {
+                    $returnTypeValue[] =  $type->getName();
+                }
+
+                $returnTypeValue = implode('|', $returnTypeValue);
+            } else {
+                $className = $method->getDeclaringClass()->getName();
+                $returnTypeValue = ($returnType->allowsNull() && $returnType->getName() !== 'mixed' ? '?' : '');
+                $returnTypeValue .= ($returnType->getName() === 'self')
+                    ? $className ? '\\' . ltrim($className, '\\') : ''
+                    : $returnType->getName();
+            }
+        }
+
+        return $returnTypeValue;
+    }
+}
diff --git a/lib/internal/Magento/Framework/Interception/Code/Generator/Interceptor.php b/lib/internal/Magento/Framework/Interception/Code/Generator/Interceptor.php
@@ -8,9 +8,12 @@
 namespace Magento\Framework\Interception\Code\Generator;
 
 use Magento\Framework\Code\Generator\EntityAbstract;
+use Magento\Framework\GetReflectionMethodReturnTypeValueTrait;
 
 class Interceptor extends EntityAbstract
 {
+    use GetReflectionMethodReturnTypeValueTrait;
+
     public const ENTITY_TYPE = 'interceptor';
 
     /**
@@ -200,35 +203,4 @@ protected function _validateData()
 
         return $result;
     }
-
-    /**
-     * Returns return type
-     *
-     * @param \ReflectionMethod $method
-     * @return null|string
-     */
-    private function getReturnTypeValue(\ReflectionMethod $method): ?string
-    {
-        $returnTypeValue = null;
-        $returnType = $method->getReturnType();
-        if ($returnType) {
-
-            if ($returnType instanceof \ReflectionUnionType) {
-                $returnTypeValue = [];
-                foreach ($method->getReturnType()->getTypes() as $type) {
-                    $returnTypeValue[] =  $type->getName();
-                }
-
-                $returnTypeValue = implode('|', $returnTypeValue);
-
-            } else {
-                $returnTypeValue = ($returnType->allowsNull() && $returnType->getName() !== 'mixed' ? '?' : '');
-                $returnTypeValue .= ($returnType->getName() === 'self')
-                    ? $this->_getFullyQualifiedClassName($method->getDeclaringClass()->getName())
-                    : $returnType->getName();
-            }
-        }
-
-        return $returnTypeValue;
-    }
 }
diff --git a/lib/internal/Magento/Framework/Interception/Test/Unit/Code/Generator/_files/ReflectionUnionTypeSample.php b/lib/internal/Magento/Framework/Interception/Test/Unit/Code/Generator/_files/ReflectionUnionTypeSample.php
@@ -9,6 +9,9 @@
 
 class ReflectionUnionTypeSample
 {
+    /**
+     * @var int|string
+     */
     private int|string $attribute;
 
     public function getValue(): int|string
diff --git a/lib/internal/Magento/Framework/MessageQueue/Code/Generator/RemoteServiceGenerator.php b/lib/internal/Magento/Framework/MessageQueue/Code/Generator/RemoteServiceGenerator.php
@@ -20,8 +20,8 @@
  */
 class RemoteServiceGenerator extends \Magento\Framework\Code\Generator\EntityAbstract
 {
-    const ENTITY_TYPE = 'remote';
-    const REMOTE_SERVICE_SUFFIX = 'Remote';
+    public const ENTITY_TYPE = 'remote';
+    public const REMOTE_SERVICE_SUFFIX = 'Remote';
 
     /**
      * @var CommunicationConfig
@@ -241,6 +241,7 @@ protected function validateResultClassName()
      * @return ReflectionGenerator
      *
      * @deprecated 103.0.0
+     * @see https://jira.corp.adobe.com/browse/MAGETWO-56305
      */
     private function getReflectionGenerator()
     {
diff --git a/lib/internal/Magento/Framework/ObjectManager/Code/Generator/Proxy.php b/lib/internal/Magento/Framework/ObjectManager/Code/Generator/Proxy.php
@@ -7,8 +7,12 @@
 
 namespace Magento\Framework\ObjectManager\Code\Generator;
 
+use Magento\Framework\GetReflectionMethodReturnTypeValueTrait;
+
 class Proxy extends \Magento\Framework\Code\Generator\EntityAbstract
 {
+    use GetReflectionMethodReturnTypeValueTrait;
+
     /**
      * Entity type
      */
@@ -268,34 +272,4 @@ protected function _validateData()
 
         return $result;
     }
-
-    /**
-     * Returns return type
-     *
-     * @param \ReflectionMethod $method
-     * @return null|string
-     */
-    private function getReturnTypeValue(\ReflectionMethod $method): ?string
-    {
-        $returnTypeValue = null;
-        $returnType = $method->getReturnType();
-        if ($returnType) {
-            if ($returnType instanceof \ReflectionUnionType) {
-                $returnTypeValue = [];
-                foreach ($method->getReturnType()->getTypes() as $type) {
-                    $returnTypeValue[] =  $type->getName();
-                }
-
-                $returnTypeValue = implode('|', $returnTypeValue);
-
-            } else {
-                $returnTypeValue = ($returnType->allowsNull() && $returnType->getName() !== 'mixed' ? '?' : '');
-                $returnTypeValue .= ($returnType->getName() === 'self')
-                    ? $this->_getFullyQualifiedClassName($method->getDeclaringClass()->getName())
-                    : $returnType->getName();
-            }
-        }
-
-        return $returnTypeValue;
-    }
 }
diff --git a/lib/internal/Magento/Framework/ObjectManager/Code/Generator/Repository.php b/lib/internal/Magento/Framework/ObjectManager/Code/Generator/Repository.php
@@ -18,13 +18,14 @@
  * Class Repository
  * @deprecated 101.0.0 As current implementation breaks Repository contract. Not removed from codebase to prevent
  * possible backward incompatibilities if this functionality being used by 3rd party developers.
+ * @see https://jira.corp.adobe.com/browse/MAGETWO-70985
  */
 class Repository extends \Magento\Framework\Code\Generator\EntityAbstract
 {
     /**
      * Entity type repository
      */
-    const ENTITY_TYPE = 'repository';
+    public const ENTITY_TYPE = 'repository';
 
     /**
      * The namespace of repository interface
diff --git a/lib/internal/Magento/Framework/Reflection/TypeProcessor.php b/lib/internal/Magento/Framework/Reflection/TypeProcessor.php
@@ -59,7 +59,8 @@ class TypeProcessor
      *
      * @return NameFinder
      *
-     * @deprecated 100.1.0
+     * @deprecated 100.1.0 Refactor TypeProcessor
+     * @see https://jira.corp.adobe.com/browse/MAGETWO-51906
      */
     private function getNameFinder()
     {
@@ -254,7 +255,8 @@ public function getDescription(DocBlockReflection $doc)
      * @param string $getterName
      * @return string
      *
-     * @deprecated 100.1.0
+     * @deprecated 100.1.0 Refactor TypeProcessor
+     * @see https://jira.corp.adobe.com/browse/MAGETWO-51906
      */
     public function dataObjectGetterNameToFieldName($getterName)
     {
@@ -267,7 +269,8 @@ public function dataObjectGetterNameToFieldName($getterName)
      * @param string $shortDescription
      * @return string
      *
-     * @deprecated 100.1.0
+     * @deprecated 100.1.0 Refactor TypeProcessor
+     * @see https://jira.corp.adobe.com/browse/MAGETWO-51906
      */
     protected function dataObjectGetterDescriptionToFieldDescription($shortDescription)
     {
@@ -701,7 +704,8 @@ public function getParamDescription(ParameterReflection $param)
      * @return string processed method name
      * @throws \Exception If $camelCaseProperty has no corresponding getter method
      *
-     * @deprecated 100.1.0
+     * @deprecated 100.1.0 Refactor TypeProcessor
+     * @see https://jira.corp.adobe.com/browse/MAGETWO-51906
      */
     public function findGetterMethodName(ClassReflection $class, $camelCaseProperty)
     {
@@ -739,7 +743,8 @@ protected function setType(&$value, $type)
      * @return string processed method name
      * @throws \Exception If $camelCaseProperty has no corresponding setter method
      *
-     * @deprecated 100.1.0
+     * @deprecated 100.1.0 Refactor TypeProcessor
+     * @see https://jira.corp.adobe.com/browse/MAGETWO-51906
      */
     public function findSetterMethodName(ClassReflection $class, $camelCaseProperty)
     {
@@ -756,7 +761,8 @@ public function findSetterMethodName(ClassReflection $class, $camelCaseProperty)
      * @return string processed method name
      * @throws \Exception If $camelCaseProperty has no corresponding setter method
      *
-     * @deprecated 100.1.0
+     * @deprecated 100.1.0 Refactor TypeProcessor
+     * @see https://jira.corp.adobe.com/browse/MAGETWO-51906
      */
     protected function findAccessorMethodName(
         ClassReflection $class,
@@ -777,7 +783,8 @@ protected function findAccessorMethodName(
      * @param string $methodName
      * @return bool
      *
-     * @deprecated 100.1.0
+     * @deprecated 100.1.0 Refactor TypeProcessor
+     * @see https://jira.corp.adobe.com/browse/MAGETWO-51906
      */
     protected function classHasMethod(ClassReflection $class, $methodName)
     {

Original file line number	Diff line number	Diff line change
`@@ -76,6 +76,8 @@ function ($checkDictionary, $params) use ($dictionary, $area, $theme, $locale) {`
`76`	`76`	`$this->assertEquals($area, $params['area']);`
`77`	`77`	`$this->assertEquals($theme, $params['theme']);`
`78`	`78`	`$this->assertEquals($locale, $params['locale']);`
	`79`	`+`
	`80`	`+ return $dictionary;`
`79`	`81`	`}`
`80`	`82`	`);`
`81`	`83`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,9 @@`
`9`	`9`
`10`	`10`	`class ReflectionUnionTypeSample`
`11`	`11`	`{`
	`12`	`+ /**`
	`13`	`+ * @var int\|string`
	`14`	`+ */`
`12`	`15`	`private int\|string $attribute;`
`13`	`16`
`14`	`17`	`public function getValue(): int\|string`
Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,8 @@`
`20`	`20`	`*/`
`21`	`21`	`class RemoteServiceGenerator extends \Magento\Framework\Code\Generator\EntityAbstract`
`22`	`22`	`{`
`23`		`- const ENTITY_TYPE = 'remote';`
`24`		`- const REMOTE_SERVICE_SUFFIX = 'Remote';`
	`23`	`+ public const ENTITY_TYPE = 'remote';`
	`24`	`+ public const REMOTE_SERVICE_SUFFIX = 'Remote';`
`25`	`25`
`26`	`26`	`/**`
`27`	`27`	`* @var CommunicationConfig`
`@@ -241,6 +241,7 @@ protected function validateResultClassName()`
`241`	`241`	`* @return ReflectionGenerator`
`242`	`242`	`*`
`243`	`243`	`* @deprecated 103.0.0`
	`244`	`+ * @see https://jira.corp.adobe.com/browse/MAGETWO-56305`
`244`	`245`	`*/`
`245`	`246`	`private function getReflectionGenerator()`
`246`	`247`	`{`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,8 @@ class TypeProcessor`
`59`	`59`	`*`
`60`	`60`	`* @return NameFinder`
`61`	`61`	`*`
`62`		`- * @deprecated 100.1.0`
	`62`	`+ * @deprecated 100.1.0 Refactor TypeProcessor`
	`63`	`+ * @see https://jira.corp.adobe.com/browse/MAGETWO-51906`
`63`	`64`	`*/`
`64`	`65`	`private function getNameFinder()`
`65`	`66`	`{`
`@@ -254,7 +255,8 @@ public function getDescription(DocBlockReflection $doc)`
`254`	`255`	`* @param string $getterName`
`255`	`256`	`* @return string`
`256`	`257`	`*`
`257`		`- * @deprecated 100.1.0`
	`258`	`+ * @deprecated 100.1.0 Refactor TypeProcessor`
	`259`	`+ * @see https://jira.corp.adobe.com/browse/MAGETWO-51906`
`258`	`260`	`*/`
`259`	`261`	`public function dataObjectGetterNameToFieldName($getterName)`
`260`	`262`	`{`
`@@ -267,7 +269,8 @@ public function dataObjectGetterNameToFieldName($getterName)`
`267`	`269`	`* @param string $shortDescription`
`268`	`270`	`* @return string`
`269`	`271`	`*`
`270`		`- * @deprecated 100.1.0`
	`272`	`+ * @deprecated 100.1.0 Refactor TypeProcessor`
	`273`	`+ * @see https://jira.corp.adobe.com/browse/MAGETWO-51906`
`271`	`274`	`*/`
`272`	`275`	`protected function dataObjectGetterDescriptionToFieldDescription($shortDescription)`
`273`	`276`	`{`
`@@ -701,7 +704,8 @@ public function getParamDescription(ParameterReflection $param)`
`701`	`704`	`* @return string processed method name`
`702`	`705`	`* @throws \Exception If $camelCaseProperty has no corresponding getter method`
`703`	`706`	`*`
`704`		`- * @deprecated 100.1.0`
	`707`	`+ * @deprecated 100.1.0 Refactor TypeProcessor`
	`708`	`+ * @see https://jira.corp.adobe.com/browse/MAGETWO-51906`
`705`	`709`	`*/`
`706`	`710`	`public function findGetterMethodName(ClassReflection $class, $camelCaseProperty)`
`707`	`711`	`{`
`@@ -739,7 +743,8 @@ protected function setType(&$value, $type)`
`739`	`743`	`* @return string processed method name`
`740`	`744`	`* @throws \Exception If $camelCaseProperty has no corresponding setter method`
`741`	`745`	`*`
`742`		`- * @deprecated 100.1.0`
	`746`	`+ * @deprecated 100.1.0 Refactor TypeProcessor`
	`747`	`+ * @see https://jira.corp.adobe.com/browse/MAGETWO-51906`
`743`	`748`	`*/`
`744`	`749`	`public function findSetterMethodName(ClassReflection $class, $camelCaseProperty)`
`745`	`750`	`{`
`@@ -756,7 +761,8 @@ public function findSetterMethodName(ClassReflection $class, $camelCaseProperty)`
`756`	`761`	`* @return string processed method name`
`757`	`762`	`* @throws \Exception If $camelCaseProperty has no corresponding setter method`
`758`	`763`	`*`
`759`		`- * @deprecated 100.1.0`
	`764`	`+ * @deprecated 100.1.0 Refactor TypeProcessor`
	`765`	`+ * @see https://jira.corp.adobe.com/browse/MAGETWO-51906`
`760`	`766`	`*/`
`761`	`767`	`protected function findAccessorMethodName(`
`762`	`768`	`ClassReflection $class,`
`@@ -777,7 +783,8 @@ protected function findAccessorMethodName(`
`777`	`783`	`* @param string $methodName`
`778`	`784`	`* @return bool`
`779`	`785`	`*`
`780`		`- * @deprecated 100.1.0`
	`786`	`+ * @deprecated 100.1.0 Refactor TypeProcessor`
	`787`	`+ * @see https://jira.corp.adobe.com/browse/MAGETWO-51906`
`781`	`788`	`*/`
`782`	`789`	`protected function classHasMethod(ClassReflection $class, $methodName)`
`783`	`790`	`{`