Reduce deprecations due to FieldMapping array access

doctrine-extensions · Oct 18, 2024 · 627676d · 627676d
1 parent ee63c20
commit 627676d
Show file tree

Hide file tree

Showing 32 changed files with 89 additions and 87 deletions.
diff --git a/doc/mapping.md b/doc/mapping.md
@@ -149,7 +149,7 @@ class Annotation implements Driver
                 }
                 // validate encoding type
                 $mapping = $meta->getFieldMapping($field);
-                if ($mapping['type'] != 'string') {
+                if (($mapping->type ?? $mapping['type']) != 'string') {
                     throw new \Exception("Only strings can be encoded");
                 }
                 // store the metadata

diff --git a/src/Blameable/Mapping/Driver/Xml.php b/src/Blameable/Mapping/Driver/Xml.php
@@ -128,6 +128,6 @@ protected function isValidField($meta, $field)
     {
         $mapping = $meta->getFieldMapping($field);
 
-        return $mapping && in_array($mapping['type'], self::VALID_TYPES, true);
+        return $mapping && in_array($mapping->type ?? $mapping['type'], self::VALID_TYPES, true);
     }
 }
diff --git a/src/Blameable/Mapping/Driver/Yaml.php b/src/Blameable/Mapping/Driver/Yaml.php
@@ -53,7 +53,7 @@ public function readExtendedMetadata($meta, array &$config)
         $mapping = $this->_getMapping($meta->getName());
 
         if (isset($mapping['fields'])) {
-            foreach ($mapping['fields'] as $field => $fieldMapping) {
+            foreach (($mapping->fields ?? $mapping['fields']) as $field => $fieldMapping) {
                 if (isset($fieldMapping['gedmo']['blameable'])) {
                     $mappingProperty = $fieldMapping['gedmo']['blameable'];
                     if (!$this->isValidField($meta, $field)) {
@@ -84,7 +84,7 @@ public function readExtendedMetadata($meta, array &$config)
         }
 
         if (isset($mapping['manyToOne'])) {
-            foreach ($mapping['manyToOne'] as $field => $fieldMapping) {
+            foreach (($mapping->manyToOne ?? $mapping['manyToOne']) as $field => $fieldMapping) {
                 if (isset($fieldMapping['gedmo']['blameable'])) {
                     $mappingProperty = $fieldMapping['gedmo']['blameable'];
                     if (!$meta->isSingleValuedAssociation($field)) {
@@ -134,6 +134,6 @@ protected function isValidField($meta, $field)
     {
         $mapping = $meta->getFieldMapping($field);
 
-        return $mapping && in_array($mapping['type'], self::VALID_TYPES, true);
+        return $mapping && in_array($mapping->type ?? $mapping['type'], self::VALID_TYPES, true);
     }
 }
diff --git a/src/IpTraceable/Mapping/Driver/Xml.php b/src/IpTraceable/Mapping/Driver/Xml.php
@@ -130,6 +130,6 @@ protected function isValidField($meta, $field)
     {
         $mapping = $meta->getFieldMapping($field);
 
-        return $mapping && in_array($mapping['type'], self::VALID_TYPES, true);
+        return $mapping && in_array($mapping->type ?? $mapping['type'], self::VALID_TYPES, true);
     }
 }
diff --git a/src/IpTraceable/Mapping/Driver/Yaml.php b/src/IpTraceable/Mapping/Driver/Yaml.php
@@ -49,7 +49,7 @@ public function readExtendedMetadata($meta, array &$config)
         $mapping = $this->_getMapping($meta->getName());
 
         if (isset($mapping['fields'])) {
-            foreach ($mapping['fields'] as $field => $fieldMapping) {
+            foreach (($mapping->fields ?? $mapping['fields']) as $field => $fieldMapping) {
                 if (isset($fieldMapping['gedmo']['ipTraceable'])) {
                     $mappingProperty = $fieldMapping['gedmo']['ipTraceable'];
                     if (!$this->isValidField($meta, $field)) {
@@ -80,7 +80,7 @@ public function readExtendedMetadata($meta, array &$config)
         }
 
         if (isset($mapping['manyToOne'])) {
-            foreach ($mapping['manyToOne'] as $field => $fieldMapping) {
+            foreach (($mapping->manyToOne ?? $mapping['manyToOne']) as $field => $fieldMapping) {
                 if (isset($fieldMapping['gedmo']['ipTraceable'])) {
                     $mappingProperty = $fieldMapping['gedmo']['ipTraceable'];
                     if (!$meta->isSingleValuedAssociation($field)) {
@@ -130,6 +130,6 @@ protected function isValidField($meta, $field)
     {
         $mapping = $meta->getFieldMapping($field);
 
-        return $mapping && in_array($mapping['type'], self::VALID_TYPES, true);
+        return $mapping && in_array($mapping->type ?? $mapping['type'], self::VALID_TYPES, true);
     }
 }
diff --git a/src/Loggable/Document/Repository/LogEntryRepository.php b/src/Loggable/Document/Repository/LogEntryRepository.php
@@ -130,17 +130,17 @@ protected function fillDocument($document, array $data)
             // Fill the embedded document
             if ($wrapped->isEmbeddedAssociation($field)) {
                 if (!empty($value)) {
-                    assert(class_exists($mapping['targetDocument']));
+                    assert(class_exists($mapping->targetDocument ?? $mapping['targetDocument']));
 
-                    $embeddedMetadata = $this->dm->getClassMetadata($mapping['targetDocument']);
+                    $embeddedMetadata = $this->dm->getClassMetadata($mapping->targetDocument ?? $mapping['targetDocument']);
                     $document = $embeddedMetadata->newInstance();
                     $this->fillDocument($document, $value);
                     $value = $document;
                 }
             } elseif ($objectMeta->isSingleValuedAssociation($field)) {
-                assert(class_exists($mapping['targetDocument']));
+                assert(class_exists($mapping->targetDocument ?? $mapping['targetDocument']));
 
-                $value = $value ? $this->dm->getReference($mapping['targetDocument'], $value) : null;
+                $value = $value ? $this->dm->getReference($mapping->targetDocument ?? $mapping['targetDocument'], $value) : null;
             }
             $wrapped->setPropertyValue($field, $value);
             unset($fields[$field]);

diff --git a/src/Loggable/Entity/Repository/LogEntryRepository.php b/src/Loggable/Entity/Repository/LogEntryRepository.php
@@ -165,7 +165,7 @@ protected function mapValue(ClassMetadata $objectMeta, $field, &$value)
         }
 
         $mapping = $objectMeta->getAssociationMapping($field);
-        $value = $value ? $this->getEntityManager()->getReference($mapping['targetEntity'], $value) : null;
+        $value = $value ? $this->getEntityManager()->getReference($mapping->targetEntity ?? $mapping['targetEntity'], $value) : null;
     }
 
     /**

diff --git a/src/Loggable/Mapping/Driver/Yaml.php b/src/Loggable/Mapping/Driver/Yaml.php
@@ -41,7 +41,7 @@ public function readExtendedMetadata($meta, array &$config)
         $mapping = $this->_getMapping($meta->getName());
 
         if (isset($mapping['gedmo'])) {
-            $classMapping = $mapping['gedmo'];
+            $classMapping = ($mapping->gedmo ?? $mapping['gedmo']);
             if (isset($classMapping['loggable'])) {
                 $config['loggable'] = true;
                 if (isset($classMapping['loggable']['logEntryClass'])) {
@@ -54,7 +54,7 @@ public function readExtendedMetadata($meta, array &$config)
         }
 
         if (isset($mapping['fields'])) {
-            foreach ($mapping['fields'] as $field => $fieldMapping) {
+            foreach (($mapping->fields ?? $mapping['fields']) as $field => $fieldMapping) {
                 if (isset($fieldMapping['gedmo'])) {
                     if (in_array('versioned', $fieldMapping['gedmo'], true)) {
                         if ($meta->isCollectionValuedAssociation($field)) {
@@ -68,7 +68,7 @@ public function readExtendedMetadata($meta, array &$config)
         }
 
         if (isset($mapping['attributeOverride'])) {
-            foreach ($mapping['attributeOverride'] as $field => $fieldMapping) {
+            foreach (($mapping->attributeOverride ?? $mapping['attributeOverride']) as $field => $fieldMapping) {
                 if (isset($fieldMapping['gedmo'])) {
                     if (in_array('versioned', $fieldMapping['gedmo'], true)) {
                         if ($meta->isCollectionValuedAssociation($field)) {
@@ -82,7 +82,7 @@ public function readExtendedMetadata($meta, array &$config)
         }
 
         if (isset($mapping['manyToOne'])) {
-            foreach ($mapping['manyToOne'] as $field => $fieldMapping) {
+            foreach (($mapping->manyToOne ?? $mapping['manyToOne']) as $field => $fieldMapping) {
                 if (isset($fieldMapping['gedmo'])) {
                     if (in_array('versioned', $fieldMapping['gedmo'], true)) {
                         if ($meta->isCollectionValuedAssociation($field)) {
@@ -96,7 +96,7 @@ public function readExtendedMetadata($meta, array &$config)
         }
 
         if (isset($mapping['oneToOne'])) {
-            foreach ($mapping['oneToOne'] as $field => $fieldMapping) {
+            foreach (($mapping->oneToOne ?? $mapping['oneToOne']) as $field => $fieldMapping) {
                 if (isset($fieldMapping['gedmo'])) {
                     if (in_array('versioned', $fieldMapping['gedmo'], true)) {
                         if ($meta->isCollectionValuedAssociation($field)) {
@@ -110,7 +110,7 @@ public function readExtendedMetadata($meta, array &$config)
         }
 
         if (isset($mapping['embedded'])) {
-            foreach ($mapping['embedded'] as $field => $fieldMapping) {
+            foreach (($mapping->embedded ?? $mapping['embedded']) as $field => $fieldMapping) {
                 if (isset($fieldMapping['gedmo'])) {
                     if (in_array('versioned', $fieldMapping['gedmo'], true)) {
                         if ($meta->isCollectionValuedAssociation($field)) {
@@ -150,7 +150,7 @@ protected function _loadMappingFile($file)
     private function inspectEmbeddedForVersioned(string $field, array $mapping, array $config): array
     {
         if (isset($mapping['fields'])) {
-            foreach ($mapping['fields'] as $property => $fieldMapping) {
+            foreach (($mapping->fields ?? $mapping['fields']) as $property => $fieldMapping) {
                 $config['versioned'][] = $field.'.'.$property;
             }
         }

diff --git a/src/Mapping/Driver/AbstractAnnotationDriver.php b/src/Mapping/Driver/AbstractAnnotationDriver.php
@@ -131,7 +131,7 @@ protected function isValidField($meta, $field)
     {
         $mapping = $meta->getFieldMapping($field);
 
-        return $mapping && in_array($mapping['type'], $this->validTypes, true);
+        return $mapping && in_array($mapping->type ?? $mapping['type'], $this->validTypes, true);
     }
 
     /**

diff --git a/src/ReferenceIntegrity/Mapping/Driver/Yaml.php b/src/ReferenceIntegrity/Mapping/Driver/Yaml.php
@@ -41,21 +41,21 @@ public function readExtendedMetadata($meta, array &$config)
         $validator = new Validator();
 
         if (isset($mapping['fields'])) {
-            foreach ($mapping['fields'] as $property => $fieldMapping) {
+            foreach (($mapping->fields ?? $mapping['fields']) as $property => $fieldMapping) {
                 if (isset($fieldMapping['gedmo']['referenceIntegrity'])) {
                     if (!$meta->hasField($property)) {
                         throw new InvalidMappingException(sprintf('Unable to find reference integrity [%s] as mapped property in entity - %s', $property, $meta->getName()));
                     }
 
-                    if (empty($mapping['fields'][$property]['mappedBy'])) {
+                    if (empty(($mapping->fields ?? $mapping['fields'])[$property]['mappedBy'])) {
                         throw new InvalidMappingException(sprintf("'mappedBy' should be set on '%s' in '%s'", $property, $meta->getName()));
                     }
 
                     if (!in_array($fieldMapping['gedmo']['referenceIntegrity'], $validator->getIntegrityActions(), true)) {
                         throw new InvalidMappingException(sprintf('Field - [%s] does not have a valid integrity option, [%s] in class - %s', $property, implode(', ', $validator->getIntegrityActions()), $meta->getName()));
                     }
 
-                    $config['referenceIntegrity'][$property][$mapping['fields'][$property]['mappedBy']] =
+                    $config['referenceIntegrity'][$property][($mapping->fields ?? $mapping['fields'])[$property]['mappedBy']] =
                         $fieldMapping['gedmo']['referenceIntegrity'];
                 }
             }

diff --git a/src/References/Mapping/Driver/Yaml.php b/src/References/Mapping/Driver/Yaml.php
@@ -42,8 +42,8 @@ public function readExtendedMetadata($meta, array &$config)
     {
         $mapping = $this->_getMapping($meta->getName());
 
-        if (isset($mapping['gedmo'], $mapping['gedmo']['reference'])) {
-            foreach ($mapping['gedmo']['reference'] as $field => $fieldMapping) {
+        if (isset($mapping['gedmo'], ($mapping->gedmo ?? $mapping['gedmo'])['reference'])) {
+            foreach (($mapping->gedmo ?? $mapping['gedmo'])['reference'] as $field => $fieldMapping) {
                 $reference = $fieldMapping['reference'];
 
                 if (!in_array($reference, array_keys($this->validReferences), true)) {

diff --git a/src/References/ReferencesListener.php b/src/References/ReferencesListener.php
@@ -92,16 +92,16 @@ public function postLoad(EventArgs $eventArgs)
 
         if (isset($config['referenceOne'])) {
             foreach ($config['referenceOne'] as $mapping) {
-                $property = $meta->reflClass->getProperty($mapping['field']);
+                $property = $meta->reflClass->getProperty($mapping->field ?? $mapping['field']);
                 $property->setAccessible(true);
                 if (isset($mapping['identifier'])) {
-                    $referencedObjectId = $meta->getFieldValue($object, $mapping['identifier']);
+                    $referencedObjectId = $meta->getFieldValue($object, ($mapping->identifier ?? $mapping['identifier']));
                     if (null !== $referencedObjectId) {
                         $property->setValue(
                             $object,
                             $ea->getSingleReference(
-                                $this->getManager($mapping['type']),
-                                $mapping['class'],
+                                $this->getManager($mapping->type ?? $mapping['type']),
+                                ($mapping->class ?? $mapping['class']),
                                 $referencedObjectId
                             )
                         );
@@ -112,16 +112,16 @@ public function postLoad(EventArgs $eventArgs)
 
         if (isset($config['referenceMany'])) {
             foreach ($config['referenceMany'] as $mapping) {
-                $property = $meta->reflClass->getProperty($mapping['field']);
+                $property = $meta->reflClass->getProperty($mapping->field ?? $mapping['field']);
                 $property->setAccessible(true);
                 if (isset($mapping['mappedBy'])) {
                     $id = $ea->extractIdentifier($om, $object);
-                    $manager = $this->getManager($mapping['type']);
-                    $class = $mapping['class'];
+                    $manager = $this->getManager($mapping->type ?? $mapping['type']);
+                    $class = ($mapping->class ?? $mapping['class']);
                     $refMeta = $manager->getClassMetadata($class);
                     $refConfig = $this->getConfiguration($manager, $refMeta->getName());
-                    if (isset($refConfig['referenceOne'][$mapping['mappedBy']])) {
-                        $refMapping = $refConfig['referenceOne'][$mapping['mappedBy']];
+                    if (isset($refConfig['referenceOne'][($mapping->mappedBy ?? $mapping['mappedBy'])])) {
+                        $refMapping = $refConfig['referenceOne'][($mapping->mappedBy ?? $mapping['mappedBy'])];
                         $identifier = $refMapping['identifier'];
                         $property->setValue(
                             $object,
@@ -220,18 +220,18 @@ public function updateManyEmbedReferences(EventArgs $eventArgs)
 
         if (isset($config['referenceManyEmbed'])) {
             foreach ($config['referenceManyEmbed'] as $mapping) {
-                $property = $meta->reflClass->getProperty($mapping['field']);
+                $property = $meta->reflClass->getProperty($mapping->field ?? $mapping['field']);
                 $property->setAccessible(true);
 
                 $id = $ea->extractIdentifier($om, $object);
                 $manager = $this->getManager('document');
 
-                $class = $mapping['class'];
+                $class = ($mapping->class ?? $mapping['class']);
                 $refMeta = $manager->getClassMetadata($class);
                 // Trigger the loading of the configuration to validate the mapping
                 $this->getConfiguration($manager, $refMeta->getName());
 
-                $identifier = $mapping['identifier'];
+                $identifier = ($mapping->identifier ?? $mapping['identifier']);
                 $property->setValue(
                     $object,
                     new LazyCollection(
@@ -271,17 +271,17 @@ private function updateReferences(EventArgs $eventArgs): void
         if (isset($config['referenceOne'])) {
             foreach ($config['referenceOne'] as $mapping) {
                 if (isset($mapping['identifier'])) {
-                    $property = $meta->reflClass->getProperty($mapping['field']);
+                    $property = $meta->reflClass->getProperty($mapping->field ?? $mapping['field']);
                     $property->setAccessible(true);
                     $referencedObject = $property->getValue($object);
 
                     if (is_object($referencedObject)) {
-                        $manager = $this->getManager($mapping['type']);
+                        $manager = $this->getManager($mapping->type ?? $mapping['type']);
                         $identifier = $ea->getIdentifier($manager, $referencedObject);
 
                         $meta->setFieldValue(
                             $object,
-                            $mapping['identifier'],
+                            ($mapping->identifier ?? $mapping['identifier']),
                             $identifier
                         );
                     }

diff --git a/src/Sluggable/Mapping/Driver/Xml.php b/src/Sluggable/Mapping/Driver/Xml.php
@@ -76,7 +76,7 @@ protected function isValidField($meta, $field)
     {
         $mapping = $meta->getFieldMapping($field);
 
-        return $mapping && in_array($mapping['type'], self::VALID_TYPES, true);
+        return $mapping && in_array($mapping->type ?? $mapping['type'], self::VALID_TYPES, true);
     }
 
     /**

diff --git a/src/Sluggable/Mapping/Driver/Yaml.php b/src/Sluggable/Mapping/Driver/Yaml.php
@@ -54,13 +54,13 @@ public function readExtendedMetadata($meta, array &$config)
         $mapping = $this->_getMapping($meta->getName());
 
         if (isset($mapping['fields'])) {
-            foreach ($mapping['fields'] as $field => $fieldMapping) {
+            foreach (($mapping->fields ?? $mapping['fields']) as $field => $fieldMapping) {
                 $config = $this->buildFieldConfiguration($field, $fieldMapping, $meta, $config);
             }
         }
 
         if (isset($mapping['attributeOverride'])) {
-            foreach ($mapping['attributeOverride'] as $field => $overrideMapping) {
+            foreach (($mapping->attributeOverride ?? $mapping['attributeOverride']) as $field => $overrideMapping) {
                 $config = $this->buildFieldConfiguration($field, $overrideMapping, $meta, $config);
             }
         }
@@ -85,7 +85,7 @@ protected function isValidField($meta, $field)
     {
         $mapping = $meta->getFieldMapping($field);
 
-        return $mapping && in_array($mapping['type'], self::VALID_TYPES, true);
+        return $mapping && in_array($mapping->type ?? $mapping['type'], self::VALID_TYPES, true);
     }
 
     /**

diff --git a/src/Sluggable/Mapping/Event/Adapter/ORM.php b/src/Sluggable/Mapping/Event/Adapter/ORM.php
@@ -55,13 +55,13 @@ public function getSimilarSlugs($object, $meta, array $config, $slug)
             if (($ubase || 0 === $ubase) && !$mapping) {
                 $qb->andWhere('rec.'.$config['unique_base'].' = :unique_base');
                 $qb->setParameter(':unique_base', $ubase);
-            } elseif ($ubase && $mapping && in_array($mapping['type'], [EntityClassMetadata::ONE_TO_ONE, EntityClassMetadata::MANY_TO_ONE], true)) {
+            } elseif ($ubase && $mapping && in_array($mapping->type ?? $mapping['type'], [EntityClassMetadata::ONE_TO_ONE, EntityClassMetadata::MANY_TO_ONE], true)) {
                 $mappedAlias = 'mapped_'.$config['unique_base'];
                 $wrappedUbase = AbstractWrapper::wrap($ubase, $em);
                 $metadata = $wrappedUbase->getMetadata();
                 assert($metadata instanceof EntityClassMetadata || $metadata instanceof LegacyEntityClassMetadata);
                 $qb->innerJoin('rec.'.$config['unique_base'], $mappedAlias);
-                foreach (array_keys($mapping['targetToSourceKeyColumns']) as $i => $mappedKey) {
+                foreach (array_keys($mapping->targetToSourceKeyColumns ?? $mapping['targetToSourceKeyColumns']) as $i => $mappedKey) {
                     $mappedProp = $metadata->getFieldName($mappedKey);
                     $qb->andWhere($qb->expr()->eq($mappedAlias.'.'.$mappedProp, ':assoc'.$i));
                     $qb->setParameter(':assoc'.$i, $wrappedUbase->getPropertyValue($mappedProp));