Stop passing parameters by reference in mapping drivers

Author: phansys

phpstan.neon.dist

@@ -19,6 +19,10 @@ parameters:
         - '#^Property Gedmo\\Tests\\.+\\Fixture\\[^:]+::\$\w+ is never written, only read\.$#'
         - '#^Property Gedmo\\Tests\\.+\\Fixture\\[^:]+::\$\w+ is never read, only written\.$#'
         - '#^Property Gedmo\\Tests\\.+\\Fixture\\[^:]+::\$\w+ is unused\.$#'
+        - '#^Method Gedmo\\(?:[^\\]+\\)*Mapping\\Driver[^:]+::readExtendedMetadata\(\) with return type void returns [\w\|<>\s,]+ but should not return anything\.$#'
+        - '#^Method Gedmo\\Uploadable\\Mapping\\Validator::validateConfiguration\(\) with return type void returns array<string, mixed> but should not return anything\.$#'
+        - '#^Result of static method Gedmo\\Uploadable\\Mapping\\Validator::validateConfiguration\(\) \(void\) is used\.$#'
+        - '#^Result of method Gedmo\\Mapping\\Driver::readExtendedMetadata\(\) \(void\) is used\.$#'
 
 rules:
     - PHPStan\Rules\Constants\MissingClassConstantTypehintRule

src/Blameable/Mapping/Driver/Annotation.php

@@ -88,5 +88,7 @@ public function readExtendedMetadata($meta, array &$config)
                 $config[$blameable->on][] = $field;
             }
         }
+
+        return $config;
     }
 }

src/Blameable/Mapping/Driver/Xml.php

@@ -110,6 +110,8 @@ public function readExtendedMetadata($meta, array &$config)
                 }
             }
         }
+
+        return $config;
     }
 
     /**

src/Blameable/Mapping/Driver/Yaml.php

@@ -111,6 +111,8 @@ public function readExtendedMetadata($meta, array &$config)
                 }
             }
         }
+
+        return $config;
     }
 
     protected function _loadMappingFile($file)

src/IpTraceable/Mapping/Driver/Annotation.php

@@ -79,5 +79,7 @@ public function readExtendedMetadata($meta, array &$config)
                 $config[$ipTraceable->on][] = $field;
             }
         }
+
+        return $config;
     }
 }

src/IpTraceable/Mapping/Driver/Xml.php

@@ -113,6 +113,8 @@ public function readExtendedMetadata($meta, array &$config)
                     $config[$this->_getAttribute($data, 'on')][] = $field;
                 }
             }
+
+            return $config;
         }
     }
 

src/IpTraceable/Mapping/Driver/Yaml.php

@@ -108,6 +108,8 @@ public function readExtendedMetadata($meta, array &$config)
                     $config[$mappingProperty['on']][] = $field;
                 }
             }
+
+            return $config;
         }
     }
 

src/Loggable/Mapping/Driver/Annotation.php

@@ -95,6 +95,8 @@ public function readExtendedMetadata($meta, array &$config)
                 throw new InvalidMappingException("Class must be annotated with Loggable annotation in order to track versioned fields in class - {$meta->getName()}");
             }
         }
+
+        return $config;
     }
 
     /**

src/Loggable/Mapping/Driver/Xml.php

@@ -56,22 +56,22 @@ public function readExtendedMetadata($meta, array &$config)
         }
 
         if (isset($xmlDoctrine->field)) {
-            $this->inspectElementForVersioned($xmlDoctrine->field, $config, $meta);
+            $config = $this->inspectElementForVersioned($xmlDoctrine->field, $config, $meta);
         }
         foreach ($xmlDoctrine->{'attribute-overrides'}->{'attribute-override'} ?? [] as $overrideMapping) {
-            $this->inspectElementForVersioned($overrideMapping, $config, $meta);
+            $config = $this->inspectElementForVersioned($overrideMapping, $config, $meta);
         }
         if (isset($xmlDoctrine->{'many-to-one'})) {
-            $this->inspectElementForVersioned($xmlDoctrine->{'many-to-one'}, $config, $meta);
+            $config = $this->inspectElementForVersioned($xmlDoctrine->{'many-to-one'}, $config, $meta);
         }
         if (isset($xmlDoctrine->{'one-to-one'})) {
-            $this->inspectElementForVersioned($xmlDoctrine->{'one-to-one'}, $config, $meta);
+            $config = $this->inspectElementForVersioned($xmlDoctrine->{'one-to-one'}, $config, $meta);
         }
         if (isset($xmlDoctrine->{'reference-one'})) {
-            $this->inspectElementForVersioned($xmlDoctrine->{'reference-one'}, $config, $meta);
+            $config = $this->inspectElementForVersioned($xmlDoctrine->{'reference-one'}, $config, $meta);
         }
         if (isset($xmlDoctrine->{'embedded'})) {
-            $this->inspectElementForVersioned($xmlDoctrine->{'embedded'}, $config, $meta);
+            $config = $this->inspectElementForVersioned($xmlDoctrine->{'embedded'}, $config, $meta);
         }
 
         if (!$meta->isMappedSuperclass && $config) {
@@ -82,14 +82,18 @@ public function readExtendedMetadata($meta, array &$config)
                 throw new InvalidMappingException("Class must be annotated with Loggable annotation in order to track versioned fields in class - {$meta->getName()}");
             }
         }
+
+        return $config;
     }
 
     /**
      * Searches mappings on element for versioned fields
      *
      * @param array<string, mixed> $config
+     *
+     * @return array<string, mixed>
      */
-    private function inspectElementForVersioned(\SimpleXMLElement $element, array &$config, ClassMetadata $meta): void
+    private function inspectElementForVersioned(\SimpleXMLElement $element, array $config, ClassMetadata $meta): array
     {
         foreach ($element as $mapping) {
             $mappingDoctrine = $mapping;
@@ -108,5 +112,7 @@ private function inspectElementForVersioned(\SimpleXMLElement $element, array &$
                 $config['versioned'][] = $field;
             }
         }
+
+        return $config;
     }
 }

src/Loggable/Mapping/Driver/Yaml.php

@@ -118,7 +118,7 @@ public function readExtendedMetadata($meta, array &$config)
                         }
                         // fields cannot be overrided and throws mapping exception
                         $mapping = $this->_getMapping($fieldMapping['class']);
-                        $this->inspectEmbeddedForVersioned($field, $mapping, $config);
+                        $config = $this->inspectEmbeddedForVersioned($field, $mapping, $config);
                     }
                 }
             }
@@ -132,6 +132,8 @@ public function readExtendedMetadata($meta, array &$config)
                 throw new InvalidMappingException("Class must be annotated with Loggable annotation in order to track versioned fields in class - {$meta->getName()}");
             }
         }
+
+        return $config;
     }
 
     protected function _loadMappingFile($file)
@@ -142,13 +144,17 @@ protected function _loadMappingFile($file)
     /**
      * @param array<string, array<string, array<string, mixed>>> $mapping
      * @param array<string, mixed>                               $config
+     *
+     * @return array<string, mixed>
      */
-    private function inspectEmbeddedForVersioned(string $field, array $mapping, array &$config): void
+    private function inspectEmbeddedForVersioned(string $field, array $mapping, array $config): array
     {
         if (isset($mapping['fields'])) {
             foreach ($mapping['fields'] as $property => $fieldMapping) {
                 $config['versioned'][] = $field.'.'.$property;
             }
         }
+
+        return $config;
     }
 }