AC-3160: Fix possible deprecation issues with 8.1

karyna-t · andrewbess · commit cb8c14cbeb4f · 2022-05-31T08:52:43.000+02:00
diff --git a/lib/internal/Magento/Framework/Model/ResourceModel/AbstractResource.php b/lib/internal/Magento/Framework/Model/ResourceModel/AbstractResource.php
@@ -199,7 +199,7 @@ protected function _prepareDataForTable(DataObject $object, $table)
      */
     protected function _prepareTableValueForSave($value, $type)
     {
-        $type = strtolower($type);
+        $type = $value !== null ? strtolower($type) : '';
         if ($type == 'decimal' || $type == 'numeric' || $type == 'float') {
             $value = \Magento\Framework\App\ObjectManager::getInstance()->get(
                 \Magento\Framework\Locale\FormatInterface::class
diff --git a/lib/internal/Magento/Framework/Model/ResourceModel/Db/Profiler.php b/lib/internal/Magento/Framework/Model/ResourceModel/Db/Profiler.php
@@ -1,23 +1,24 @@
 <?php
 /**
- * Magento profiler for requests to database
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 namespace Magento\Framework\Model\ResourceModel\Db;
 
+/**
+ * Magento profiler for requests to database
+ */
 class Profiler extends \Magento\Framework\DB\Profiler
 {
     /**
      * Default connection type for timer name creation
      */
-    const TIMER_PREFIX = 'DB_QUERY';
+    public const TIMER_PREFIX = 'DB_QUERY';
 
     /**
      * Default connection type for timer name creation
      */
-    const DEFAULT_CONNECTION_TYPE = 'database';
+    public const DEFAULT_CONNECTION_TYPE = 'database';
 
     /**
      * @var array Allowed query types
@@ -59,7 +60,7 @@ protected function _getTimerName($operation)
      */
     protected function _parseQueryType($queryText)
     {
-        $queryTypeParsed = strtolower(substr(ltrim($queryText), 0, 6));
+        $queryTypeParsed = $queryText !== null ? strtolower(substr(ltrim($queryText), 0, 6)) : '';
 
         if (!in_array($queryTypeParsed, $this->_queryTypes)) {
             $queryTypeParsed = 'query';
diff --git a/lib/internal/Magento/Framework/Module/Dir/ReverseResolver.php b/lib/internal/Magento/Framework/Module/Dir/ReverseResolver.php
@@ -1,7 +1,5 @@
 <?php
 /**
- * Resolves file/directory paths to modules they belong to
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
@@ -10,6 +8,9 @@
 use Magento\Framework\Module\Dir;
 use Magento\Framework\Module\ModuleListInterface;
 
+/**
+ * Resolves file/directory paths to modules they belong to
+ */
 class ReverseResolver
 {
     /**
@@ -40,7 +41,7 @@ public function __construct(ModuleListInterface $moduleList, Dir $moduleDirs)
      */
     public function getModuleName($path)
     {
-        $path = str_replace('\\', '/', $path);
+        $path = $path !== null ? str_replace('\\', '/', $path) : '';
         foreach ($this->_moduleList->getNames() as $moduleName) {
             $moduleDir = $this->_moduleDirs->getDir($moduleName);
             $moduleDir = str_replace('\\', '/', $moduleDir);
diff --git a/lib/internal/Magento/Framework/Module/PackageInfo.php b/lib/internal/Magento/Framework/Module/PackageInfo.php
@@ -190,7 +190,7 @@ protected function convertPackageNameToModuleName($packageName)
      */
     protected function isMagentoPackage($packageName)
     {
-        return strpos($packageName, 'magento/module-') === 0;
+        return $packageName !== null && strpos($packageName, 'magento/module-') === 0;
     }
 
     /**
diff --git a/lib/internal/Magento/Framework/ObjectManager/Config/Compiled.php b/lib/internal/Magento/Framework/ObjectManager/Config/Compiled.php
@@ -50,6 +50,7 @@ public function __construct($data)
      * @return void
      *
      * @SuppressWarnings(PHPMD.UnusedFormalParameter)
+     * phpcs:disable Magento2.CodeAnalysis.EmptyBlock
      */
     public function setRelations(RelationsInterface $relations)
     {
@@ -67,6 +68,7 @@ public function setRelations(RelationsInterface $relations)
     public function setCache(ConfigCacheInterface $cache)
     {
     }
+    // phpcs:enable Magento2.CodeAnalysis.EmptyBlock
 
     /**
      * Retrieve list of arguments per type
@@ -121,7 +123,7 @@ public function getInstanceType($instanceName)
      */
     public function getPreference($type)
     {
-        $type = ltrim($type, '\\');
+        $type = $type !== null ? ltrim($type, '\\') : '';
         if (isset($this->preferences[$type])) {
             return $this->preferences[$type];
         }
diff --git a/lib/internal/Magento/Framework/ObjectManager/Config/Config.php b/lib/internal/Magento/Framework/ObjectManager/Config/Config.php
@@ -170,7 +170,7 @@ public function getInstanceType($instanceName)
      */
     public function getPreference($type)
     {
-        $type = ltrim($type, '\\');
+        $type = $type !== null ? ltrim($type, '\\') : '';
         $preferencePath = [];
         while (isset($this->_preferences[$type])) {
             if (isset($preferencePath[$this->_preferences[$type]])) {
diff --git a/lib/internal/Magento/Framework/Parse/Zip.php b/lib/internal/Magento/Framework/Parse/Zip.php
@@ -32,7 +32,7 @@ public static function parseRegions($state, $zip)
      */
     public static function parseZip($zip)
     {
-        if (strpos($zip, '-') === false) {
+        if ($zip === null || strpos($zip, '-') === false) {
             return [$zip];
         } else {
             return self::zipRangeToZipPattern($zip);
diff --git a/lib/internal/Magento/Framework/Phrase/Renderer/Inline.php b/lib/internal/Magento/Framework/Phrase/Renderer/Inline.php
@@ -63,7 +63,8 @@ public function render(array $source, array $arguments)
                 return $text;
             }
 
-            if (strpos($text, '{{{') === false
+            if ($text === null
+                || strpos($text, '{{{') === false
                 || strpos($text, '}}}') === false
                 || strpos($text, '}}{{') === false
             ) {
diff --git a/lib/internal/Magento/Framework/Profiler.php b/lib/internal/Magento/Framework/Profiler.php
@@ -19,7 +19,7 @@ class Profiler
     /**
      * Separator literal to assemble timer identifier from timer names
      */
-    const NESTING_SEPARATOR = '->';
+    public const NESTING_SEPARATOR = '->';
 
     /**
      * Whether profiling is active or not
@@ -262,7 +262,7 @@ public static function start($timerName, array $tags = null)
             return;
         }
 
-        if (strpos($timerName, self::NESTING_SEPARATOR) !== false) {
+        if ($timerName !== null && strpos($timerName, self::NESTING_SEPARATOR) !== false) {
             throw new \InvalidArgumentException('Timer name must not contain a nesting separator.');
         }
 
diff --git a/lib/internal/Magento/Framework/Profiler/Driver/Standard/Stat.php b/lib/internal/Magento/Framework/Profiler/Driver/Standard/Stat.php
@@ -1,7 +1,5 @@
 <?php
 /**
- * Storage for timers statistics
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
@@ -12,25 +10,29 @@
 use Magento\Framework\Profiler;
 
 /**
+ * Storage for timers statistics
+ *
  * @api
  */
 class Stat
 {
     /**
      * #@+ Timer statistics data keys
      */
-    const ID = 'id';
-    const START = 'start';
-    const TIME = 'sum';
-    const COUNT = 'count';
-    const AVG = 'avg';
-    const REALMEM = 'realmem';
-    const REALMEM_START = 'realmem_start';
-    const EMALLOC = 'emalloc';
-    const EMALLOC_START = 'emalloc_start';
+    public const ID = 'id';
+    public const START = 'start';
+    public const TIME = 'sum';
+    public const COUNT = 'count';
+    public const AVG = 'avg';
+    public const REALMEM = 'realmem';
+    public const REALMEM_START = 'realmem_start';
+    public const EMALLOC = 'emalloc';
+    public const EMALLOC_START = 'emalloc_start';
     /**#@-*/
 
-    /**#@-*/
+    /**
+     * @var array
+     */
     protected $_timers = [];
 
     /**
@@ -205,7 +207,8 @@ protected function _getOrderedTimerIds()
 
         $prevTimerId = $timerIds[0];
         $result = [$prevTimerId];
-        for ($i = 1; $i < count($timerIds); $i++) {
+        $numberTimerIds = count($timerIds);
+        for ($i = 1; $i < $numberTimerIds; $i++) {
             $timerId = $timerIds[$i];
             /* Skip already added timer */
             if (!$timerId) {
@@ -214,8 +217,9 @@ protected function _getOrderedTimerIds()
             /* Loop over all timers that need to be closed under previous timer */
             while (strpos($timerId, $prevTimerId . Profiler::NESTING_SEPARATOR) !== 0) {
                 /* Add to result all timers nested in the previous timer */
-                for ($j = $i + 1; $j < count($timerIds); $j++) {
-                    if (strpos($timerIds[$j], $prevTimerId . Profiler::NESTING_SEPARATOR) === 0) {
+                for ($j = $i + 1; $j < $numberTimerIds; $j++) {
+                    if (isset($timerIds[$j]) &&
+                        strpos($timerIds[$j], $prevTimerId . Profiler::NESTING_SEPARATOR) === 0) {
                         $result[] = $timerIds[$j];
                         /* Mark timer as already added */
                         $timerIds[$j] = null;
diff --git a/lib/internal/Magento/Framework/Reflection/DataObjectProcessor.php b/lib/internal/Magento/Framework/Reflection/DataObjectProcessor.php
@@ -77,6 +77,7 @@ public function __construct(
      * @param string $dataObjectType
      * @return array
      * @SuppressWarnings(PHPMD.CyclomaticComplexity)
+     * @SuppressWarnings(PHPMD.NPathComplexity)
      */
     public function buildOutputDataArray($dataObject, $dataObjectType)
     {
@@ -115,7 +116,7 @@ public function buildOutputDataArray($dataObject, $dataObjectType)
                     $value = $this->buildOutputDataArray($value, $returnType);
                 } elseif (is_array($value)) {
                     $valueResult = [];
-                    $arrayElementType = substr($returnType, 0, -2);
+                    $arrayElementType = $returnType !== null ? substr($returnType, 0, -2) : '';
                     foreach ($value as $singleValue) {
                         if (is_object($singleValue) && !($singleValue instanceof Phrase)) {
                             $singleValue = $this->buildOutputDataArray($singleValue, $arrayElementType);
diff --git a/lib/internal/Magento/Framework/Reflection/ExtensionAttributesProcessor.php b/lib/internal/Magento/Framework/Reflection/ExtensionAttributesProcessor.php
@@ -118,7 +118,7 @@ public function buildOutputDataArray(ExtensionAttributesInterface $dataObject, $
                 $value = $this->dataObjectProcessor->buildOutputDataArray($value, $returnType);
             } elseif (is_array($value)) {
                 $valueResult = [];
-                $arrayElementType = substr($returnType, 0, -2);
+                $arrayElementType = $returnType !== null ? substr($returnType, 0, -2) : '';
                 foreach ($value as $singleValue) {
                     if (is_object($singleValue) && !($singleValue instanceof Phrase)) {
                         $singleValue = $this->dataObjectProcessor->buildOutputDataArray(
diff --git a/lib/internal/Magento/Framework/Reflection/FieldNamer.php b/lib/internal/Magento/Framework/Reflection/FieldNamer.php
@@ -13,10 +13,10 @@
  */
 class FieldNamer
 {
-    const IS_METHOD_PREFIX = 'is';
-    const HAS_METHOD_PREFIX = 'has';
-    const GETTER_PREFIX = 'get';
-    
+    public const IS_METHOD_PREFIX = 'is';
+    public const HAS_METHOD_PREFIX = 'has';
+    public const GETTER_PREFIX = 'get';
+
     /**
      * Converts a method's name into a data field name.
      *
@@ -25,6 +25,7 @@ class FieldNamer
      */
     public function getFieldNameForMethodName($methodName)
     {
+        $methodName = $methodName ?? ''; // @phpstan-ignore-line
         if (substr($methodName, 0, 2) === self::IS_METHOD_PREFIX) {
             return SimpleDataObjectConverter::camelCaseToSnakeCase(substr($methodName, 2));
         } elseif (substr($methodName, 0, 3) === self::HAS_METHOD_PREFIX) {
diff --git a/lib/internal/Magento/Framework/Reflection/TypeProcessor.php b/lib/internal/Magento/Framework/Reflection/TypeProcessor.php
@@ -238,8 +238,8 @@ public function getDescription(DocBlockReflection $doc)
         $shortDescription = $doc->getShortDescription();
         $longDescription = $doc->getLongDescription();
 
-        $description = rtrim($shortDescription);
-        $longDescription = str_replace(["\n", "\r"], '', $longDescription);
+        $description = $shortDescription !== null ? rtrim($shortDescription) : '';
+        $longDescription = $longDescription !== null ? str_replace(["\n", "\r"], '', $longDescription) : '';
         if (!empty($longDescription) && !empty($description)) {
             $description .= " ";
         }
@@ -558,7 +558,7 @@ public function getParamType(ParameterReflection $param)
      */
     public function getAliasMapping(ClassReflection $sourceClass): array
     {
-        $uses = (new FileScanner($sourceClass->getFileName()))->getUses();
+        $uses = (new FileScanner($sourceClass->getFileName()))->getUses() ?? [];
         $aliases = [];
         foreach ($uses as $use) {
             if ($use['as'] !== null) {
diff --git a/lib/internal/Magento/Framework/Search/Request/Binder.php b/lib/internal/Magento/Framework/Search/Request/Binder.php
@@ -82,7 +82,7 @@ private function processDimensions($data, $bindData)
     private function processData($data, $bindData)
     {
         array_walk_recursive($bindData, function (&$item) {
-            $item = trim($item);
+            $item = $item !== null ? trim($item) : '';
         });
         $bindData = array_filter($bindData, function ($element) {
             return is_array($element) ? count($element) : strlen($element);
diff --git a/lib/internal/Magento/Framework/Session/Config.php b/lib/internal/Magento/Framework/Session/Config.php
@@ -1,7 +1,5 @@
 <?php
 /**
- * Session configuration object
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
@@ -16,20 +14,20 @@
 use Magento\Framework\Session\Config\Validator\CookieSameSiteValidator;
 
 /**
- * Magento session configuration
+ * Magento session configuration object
  *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
 class Config implements ConfigInterface
 {
     /** Configuration path for session save method */
-    const PARAM_SESSION_SAVE_METHOD = 'session/save';
+    public const PARAM_SESSION_SAVE_METHOD = 'session/save';
 
     /** Configuration path for session save path */
-    const PARAM_SESSION_SAVE_PATH = 'session/save_path';
+    public const PARAM_SESSION_SAVE_PATH = 'session/save_path';
 
     /** Configuration path for session cache limiter */
-    const PARAM_SESSION_CACHE_LIMITER = 'session/cache_limiter';
+    public const PARAM_SESSION_CACHE_LIMITER = 'session/cache_limiter';
 
     /** Configuration path for session garbage collection probability */
     private const PARAM_SESSION_GC_PROBABILITY = 'session/gc_probability';
@@ -44,19 +42,19 @@ class Config implements ConfigInterface
     private const PARAM_SESSION_GC_MAXLIFETIME = 'session/gc_maxlifetime';
 
     /** Configuration path for cookie domain */
-    const XML_PATH_COOKIE_DOMAIN = 'web/cookie/cookie_domain';
+    public const XML_PATH_COOKIE_DOMAIN = 'web/cookie/cookie_domain';
 
     /** Configuration path for cookie lifetime */
-    const XML_PATH_COOKIE_LIFETIME = 'web/cookie/cookie_lifetime';
+    public const XML_PATH_COOKIE_LIFETIME = 'web/cookie/cookie_lifetime';
 
     /** Configuration path for cookie http only param */
-    const XML_PATH_COOKIE_HTTPONLY = 'web/cookie/cookie_httponly';
+    public const XML_PATH_COOKIE_HTTPONLY = 'web/cookie/cookie_httponly';
 
     /** Configuration path for cookie path */
-    const XML_PATH_COOKIE_PATH = 'web/cookie/cookie_path';
+    public const XML_PATH_COOKIE_PATH = 'web/cookie/cookie_path';
 
     /** Cookie default lifetime */
-    const COOKIE_LIFETIME_DEFAULT = 3600;
+    public const COOKIE_LIFETIME_DEFAULT = 3600;
 
     /**
      * All options
@@ -534,7 +532,7 @@ protected function getStorageOption($option)
      */
     protected function getFixedOptionName($option)
     {
-        $option = strtolower($option);
+        $option = $option !== null ? strtolower($option) : '';
 
         switch ($option) {
             case 'url_rewriter_tags':
diff --git a/lib/internal/Magento/Framework/Session/Config/Validator/CookieSameSiteValidator.php b/lib/internal/Magento/Framework/Session/Config/Validator/CookieSameSiteValidator.php
@@ -26,6 +26,6 @@ class CookieSameSiteValidator extends \Magento\Framework\Validator\AbstractValid
      */
     public function isValid($value)
     {
-        return in_array(strtolower($value), self::SAME_SITE_ALLOWED_VALUES);
+        return $value !== null && in_array(strtolower($value), self::SAME_SITE_ALLOWED_VALUES);
     }
 }
diff --git a/lib/internal/Magento/Framework/Session/SaveHandler.php b/lib/internal/Magento/Framework/Session/SaveHandler.php
@@ -124,7 +124,7 @@ public function read($sessionId): string
     {
         $sessionData = $this->callSafely('read', $sessionId);
         $sessionMaxSize = $this->sessionMaxSizeConfig->getSessionMaxSize();
-        $sessionSize = strlen($sessionData);
+        $sessionSize = $sessionData !== null ? strlen($sessionData) : 0;
 
         if ($sessionSize !== null && $sessionMaxSize < $sessionSize) {
             $sessionData = '';

Original file line number	Diff line number	Diff line change
`@@ -199,7 +199,7 @@ protected function _prepareDataForTable(DataObject $object, $table)`
`199`	`199`	`*/`
`200`	`200`	`protected function _prepareTableValueForSave($value, $type)`
`201`	`201`	`{`
`202`		`- $type = strtolower($type);`
	`202`	`+ $type = $value !== null ? strtolower($type) : '';`
`203`	`203`	`if ($type == 'decimal' \|\| $type == 'numeric' \|\| $type == 'float') {`
`204`	`204`	`$value = \Magento\Framework\App\ObjectManager::getInstance()->get(`
`205`	`205`	`\Magento\Framework\Locale\FormatInterface::class`
Original file line number	Diff line number	Diff line change
`@@ -190,7 +190,7 @@ protected function convertPackageNameToModuleName($packageName)`
`190`	`190`	`*/`
`191`	`191`	`protected function isMagentoPackage($packageName)`
`192`	`192`	`{`
`193`		`- return strpos($packageName, 'magento/module-') === 0;`
	`193`	`+ return $packageName !== null && strpos($packageName, 'magento/module-') === 0;`
`194`	`194`	`}`
`195`	`195`
`196`	`196`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -50,6 +50,7 @@ public function __construct($data)`
`50`	`50`	`* @return void`
`51`	`51`	`*`
`52`	`52`	`* @SuppressWarnings(PHPMD.UnusedFormalParameter)`
	`53`	`+ * phpcs:disable Magento2.CodeAnalysis.EmptyBlock`
`53`	`54`	`*/`
`54`	`55`	`public function setRelations(RelationsInterface $relations)`
`55`	`56`	`{`
`@@ -67,6 +68,7 @@ public function setRelations(RelationsInterface $relations)`
`67`	`68`	`public function setCache(ConfigCacheInterface $cache)`
`68`	`69`	`{`
`69`	`70`	`}`
	`71`	`+ // phpcs:enable Magento2.CodeAnalysis.EmptyBlock`
`70`	`72`
`71`	`73`	`/**`
`72`	`74`	`* Retrieve list of arguments per type`
`@@ -121,7 +123,7 @@ public function getInstanceType($instanceName)`
`121`	`123`	`*/`
`122`	`124`	`public function getPreference($type)`
`123`	`125`	`{`
`124`		`- $type = ltrim($type, '\\');`
	`126`	`+ $type = $type !== null ? ltrim($type, '\\') : '';`
`125`	`127`	`if (isset($this->preferences[$type])) {`
`126`	`128`	`return $this->preferences[$type];`
`127`	`129`	`}`
Original file line number	Diff line number	Diff line change
`@@ -170,7 +170,7 @@ public function getInstanceType($instanceName)`
`170`	`170`	`*/`
`171`	`171`	`public function getPreference($type)`
`172`	`172`	`{`
`173`		`- $type = ltrim($type, '\\');`
	`173`	`+ $type = $type !== null ? ltrim($type, '\\') : '';`
`174`	`174`	`$preferencePath = [];`
`175`	`175`	`while (isset($this->_preferences[$type])) {`
`176`	`176`	`if (isset($preferencePath[$this->_preferences[$type]])) {`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ public static function parseRegions($state, $zip)`
`32`	`32`	`*/`
`33`	`33`	`public static function parseZip($zip)`
`34`	`34`	`{`
`35`		`- if (strpos($zip, '-') === false) {`
	`35`	`+ if ($zip === null \|\| strpos($zip, '-') === false) {`
`36`	`36`	`return [$zip];`
`37`	`37`	`} else {`
`38`	`38`	`return self::zipRangeToZipPattern($zip);`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,8 @@ public function render(array $source, array $arguments)`
`63`	`63`	`return $text;`
`64`	`64`	`}`
`65`	`65`
`66`		`- if (strpos($text, '{{{') === false`
	`66`	`+ if ($text === null`
	`67`	`+ \|\| strpos($text, '{{{') === false`
`67`	`68`	`\|\| strpos($text, '}}}') === false`
`68`	`69`	`\|\| strpos($text, '}}{{') === false`
`69`	`70`	`) {`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ class Profiler`
`19`	`19`	`/**`
`20`	`20`	`* Separator literal to assemble timer identifier from timer names`
`21`	`21`	`*/`
`22`		`- const NESTING_SEPARATOR = '->';`
	`22`	`+ public const NESTING_SEPARATOR = '->';`
`23`	`23`
`24`	`24`	`/**`
`25`	`25`	`* Whether profiling is active or not`
`@@ -262,7 +262,7 @@ public static function start($timerName, array $tags = null)`
`262`	`262`	`return;`
`263`	`263`	`}`
`264`	`264`
`265`		`- if (strpos($timerName, self::NESTING_SEPARATOR) !== false) {`
	`265`	`+ if ($timerName !== null && strpos($timerName, self::NESTING_SEPARATOR) !== false) {`
`266`	`266`	`throw new \InvalidArgumentException('Timer name must not contain a nesting separator.');`
`267`	`267`	`}`
`268`	`268`