fix: if xml value is set, change value in class metadata (doctrine-ex…

…tensions#2670)

CHANGELOG.md

@@ -20,6 +20,8 @@ a release.
 ## [Unreleased]
 ### Changed
 - Add conflict with "doctrine/orm" >=2.16 (temporary change until code is fixed)
+### Fixed
+- References: fixed condition in `XML` Driver that did not allow to retrieve from the entity definition the `mappedBy` and `inversedBy` fields.
 
 ### Fixed
 - Fix bug collecting metadata for inherited mapped classes

phpstan.neon.dist

@@ -4,7 +4,7 @@ includes:
     - vendor/phpstan/phpstan-phpunit/extension.neon
 
 parameters:
-    level: 5
+    level: 6
     paths:
         - src
         - tests
@@ -13,10 +13,15 @@ parameters:
     treatPhpDocTypesAsCertain: false
     checkMissingVarTagTypehint: true
     checkMissingTypehints: true
+    # @todo: Remove the "checkGenericClassInNonGenericObjectType" definition.
+    checkGenericClassInNonGenericObjectType: false
     ignoreErrors:
         - '#^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\.$#'
+        # @todo: Remove the following ignored error when the parameters are correctly declared.
+        - '#^Method Gedmo\\[^:]+::[^\(]+\(\) has parameter \$\w+ with no value type specified in iterable type array\.$#'
+
 rules:
     - PHPStan\Rules\Constants\MissingClassConstantTypehintRule
     - PHPStan\Rules\Functions\MissingFunctionParameterTypehintRule

schemas/orm/doctrine-extensions-mapping-2-2.xsd

@@ -29,6 +29,7 @@
   <xs:element name="loggable" type="gedmo:loggable"/>
   <xs:element name="soft-deleteable" type="gedmo:soft-deleteable"/>
   <xs:element name="uploadable" type="gedmo:uploadable"/>
+  <xs:element name="reference" type="gedmo:reference"/>
   <!-- field -->
   <xs:element name="slug" type="gedmo:slug"/>
   <xs:element name="translatable" type="gedmo:translatable"/>
@@ -65,6 +66,7 @@
   <xs:complexType name="reference">
     <xs:attribute name="type" type="gedmo:reference-type" use="required" />
     <xs:attribute name="field" type="xs:string" use="required" />
+    <xs:attribute name="reference" type="xs:string" use="required" />
     <xs:attribute name="identifier" type="xs:string" use="required" />
     <xs:attribute name="class" type="xs:string" use="required" />
     <xs:attribute name="mappedBy" type="xs:string" use="optional" />

src/Mapping/Driver.php

@@ -27,6 +27,7 @@ interface Driver
      * Read the extended metadata configuration for a single mapped class.
      *
      * @param ClassMetadata&(OdmClassMetadata|OrmClassMetadata) $meta
+     * @param array<string, mixed>                              $config
      *
      * @return void
      *

src/Mapping/Driver/AbstractAnnotationDriver.php

@@ -124,6 +124,10 @@ protected function isValidField($meta, $field)
      * @param string        $name     the related object class name
      *
      * @return string related class name or empty string if does not exist
+     *
+     * @phpstan-param class-string|string $name
+     *
+     * @phpstan-return class-string|''
      */
     protected function getRelatedClassName($metadata, $name)
     {

src/Mapping/Driver/File.php

@@ -103,7 +103,9 @@ public function setOriginalDriver($driver)
      *
      * @param string $file the mapping file to load
      *
-     * @return array
+     * @return array<string, array<string, mixed>|object|null>
+     *
+     * @phpstan-return array<class-string, array<string, mixed>|object|null>
      */
     abstract protected function _loadMappingFile($file);
 
@@ -112,7 +114,9 @@ abstract protected function _loadMappingFile($file);
      *
      * @param string $className
      *
-     * @return array|object|null
+     * @return array<string, mixed>|object|null
+     *
+     * @phpstan-param class-string $className
      */
     protected function _getMapping($className)
     {
@@ -140,6 +144,10 @@ protected function _getMapping($className)
      * @param string        $name     the related object class name
      *
      * @return string related class name or empty string if does not exist
+     *
+     * @phpstan-param class-string|string $name
+     *
+     * @phpstan-return class-string|''
      */
     protected function getRelatedClassName($metadata, $name)
     {

src/Mapping/Event/AdapterInterface.php

@@ -92,7 +92,9 @@ public function getObjectState($uow, $object);
      * @param ORMUnitOfWork|MongoDBUnitOfWork $uow    The UnitOfWork as provided by the object manager
      * @param object                          $object
      *
-     * @return array
+     * @return array<string, array<int, mixed>|object>
+     *
+     * @phpstan-return array<string, array{0: mixed, 1: mixed}|object>
      */
     public function getObjectChangeSet($uow, $object);
 
@@ -123,7 +125,7 @@ public function recomputeSingleObjectChangeSet($uow, $meta, $object);
      *
      * @param ORMUnitOfWork|MongoDBUnitOfWork $uow The UnitOfWork as provided by the object manager
      *
-     * @return array
+     * @return array<int|string, object>
      */
     public function getScheduledObjectUpdates($uow);
 
@@ -132,7 +134,7 @@ public function getScheduledObjectUpdates($uow);
      *
      * @param ORMUnitOfWork|MongoDBUnitOfWork $uow The UnitOfWork as provided by the object manager
      *
-     * @return array
+     * @return array<int|string, object>
      */
     public function getScheduledObjectInsertions($uow);
 
@@ -141,7 +143,7 @@ public function getScheduledObjectInsertions($uow);
      *
      * @param ORMUnitOfWork|MongoDBUnitOfWork $uow The UnitOfWork as provided by the object manager
      *
-     * @return array
+     * @return array<int|string, object>
      */
     public function getScheduledObjectDeletions($uow);
 

src/Mapping/ExtensionMetadataFactory.php

@@ -100,7 +100,7 @@ public function __construct(ObjectManager $objectManager, string $extensionNames
      *
      * @param ClassMetadata&(DocumentClassMetadata|EntityClassMetadata) $meta
      *
-     * @return array the metatada configuration
+     * @return array<string, mixed> the metatada configuration
      */
     public function getExtensionMetadata($meta)
     {

src/ReferenceIntegrity/Mapping/Validator.php

@@ -38,7 +38,9 @@ class Validator
     /**
      * Returns a list of available integrity actions
      *
-     * @return array
+     * @return string[]
+     *
+     * @phpstan-return array<int, self::NULLIFY|self::PULL|self::RESTRICT>
      */
     public function getIntegrityActions()
     {

src/References/Mapping/Driver/Xml.php

@@ -93,10 +93,10 @@ public function readExtendedMetadata($meta, array &$config)
                         'identifier' => $identifier,
                     ];
 
-                    if (!$this->_isAttributeSet($element, 'mappedBy')) {
+                    if ($this->_isAttributeSet($element, 'mappedBy')) {
                         $config[$reference][$field]['mappedBy'] = $this->_getAttribute($element, 'mappedBy');
                     }
-                    if (!$this->_isAttributeSet($element, 'inversedBy')) {
+                    if ($this->_isAttributeSet($element, 'inversedBy')) {
                         $config[$reference][$field]['inversedBy'] = $this->_getAttribute($element, 'inversedBy');
                     }
                 }

src/References/Mapping/Event/ReferencesAdapter.php

@@ -28,7 +28,7 @@ interface ReferencesAdapter extends AdapterInterface
      * @param object        $object
      * @param bool          $single
      *
-     * @return array|string|int|null array or single identifier
+     * @return array<int|string, mixed>|string|int|null array or single identifier
      */
     public function getIdentifier($om, $object, $single = true);
 
@@ -52,7 +52,7 @@ public function getSingleReference($om, $class, $identifier);
      * @param object        $object
      * @param bool          $single
      *
-     * @return array|string|int|null array or single identifier
+     * @return array<int|string, mixed>|string|int|null array or single identifier
      */
     public function extractIdentifier($om, $object, $single = true);
 }

src/Sluggable/Mapping/Event/SluggableAdapter.php

@@ -30,7 +30,7 @@ interface SluggableAdapter extends AdapterInterface
      * @param string        $slug
      * @phpstan-param SluggableConfiguration $config
      *
-     * @return array
+     * @return array<int, array<string, mixed>>
      */
     public function getSimilarSlugs($object, $meta, array $config, $slug);
 

src/SoftDeleteable/Filter/ODM/SoftDeleteableFilter.php

@@ -39,7 +39,9 @@ class SoftDeleteableFilter extends BsonFilter
     /**
      * Gets the criteria part to add to a query.
      *
-     * @return array The criteria array, if there is available, empty array otherwise
+     * @return array<string, array<int, array<string, array<string, \DateTime>|null>>|null> The criteria array, if there is available, empty array otherwise
+     *
+     * @phpstan-return array<string, array<int, array<string, array{'$gt': \DateTime}|null>>|null>
      */
     public function addFilterCriteria(ClassMetadata $targetEntity): array
     {
@@ -96,7 +98,7 @@ public function enableForDocument($class)
     }
 
     /**
-     * @return SoftDeleteableListener|null
+     * @return SoftDeleteableListener
      */
     protected function getListener()
     {

src/Sortable/Entity/Repository/SortableRepository.php

@@ -101,7 +101,7 @@ public function getBySortableGroupsQueryBuilder(array $groupValues = [])
     }
 
     /**
-     * @return array
+     * @return array<int, object>
      */
     public function getBySortableGroups(array $groupValues = [])
     {

src/Sortable/Mapping/Driver/Yaml.php

@@ -98,6 +98,9 @@ protected function isValidField($meta, $field)
         return $mapping && in_array($mapping['type'], self::VALID_TYPES, true);
     }
 
+    /**
+     * @param iterable<string, array<string, mixed>> $mapping
+     */
     private function readSortableGroups(iterable $mapping, array &$config): void
     {
         foreach ($mapping as $field => $fieldMapping) {

src/Sortable/Mapping/Event/Adapter/ORM.php

@@ -112,6 +112,9 @@ public function updatePositions($relocation, $delta, $config)
         $q->getSingleScalarResult();
     }
 
+    /**
+     * @param iterable<string, mixed> $groups
+     */
     private function addGroupWhere(QueryBuilder $qb, ClassMetadata $metadata, iterable $groups): void
     {
         $i = 1;

src/Sortable/SortableListener.php

@@ -565,7 +565,7 @@ protected function persistRelocations(SortableAdapter $ea)
     }
 
     /**
-     * @param array $groups
+     * @param array<string, mixed> $groups
      *
      * @return string
      */
@@ -668,11 +668,11 @@ protected function addRelocation($hash, $class, $groups, $start, $stop, $delta,
     }
 
     /**
-     * @param array         $config
-     * @param ClassMetadata $meta
-     * @param object        $object
+     * @param ClassMetadata                        $meta
+     * @param array<string, array<string, string>> $config
+     * @param object                               $object
      *
-     * @return array
+     * @return array<string, mixed>
      */
     protected function getGroups($meta, $config, $object)
     {

src/Tool/Logging/DBAL/QueryAnalyzer.php

@@ -187,6 +187,9 @@ public function getExecutionTimes()
 
     /**
      * Create the SQL with mapped parameters
+     *
+     * @param array<int|string, mixed>|null       $params
+     * @param array<int|string, string|Type>|null $types
      */
     private function generateSql(string $sql, ?array $params, ?array $types): string
     {
@@ -210,6 +213,11 @@ private function generateSql(string $sql, ?array $params, ?array $types): string
 
     /**
      * Get the converted parameter list
+     *
+     * @param array<int|string, mixed>       $params
+     * @param array<int|string, string|Type> $types
+     *
+     * @return array<int|string, mixed>
      */
     private function getConvertedParams(array $params, array $types): array
     {

src/Translatable/Document/Repository/TranslationRepository.php

@@ -111,7 +111,7 @@ public function translate($document, $field, $locale, $value)
      *
      * @param object $document
      *
-     * @return array list of translations in locale groups
+     * @return array<string, array<string, string>> list of translations in locale groups
      */
     public function findTranslations($document)
     {
@@ -203,7 +203,7 @@ public function findObjectByTranslatedField($field, $value, $class)
      *
      * @param mixed $id primary key value of document
      *
-     * @return array
+     * @return array<string, array<string, string>>
      */
     public function findTranslationsByObjectId($id)
     {

src/Translatable/Entity/Repository/TranslationRepository.php

@@ -116,7 +116,7 @@ public function translate($entity, $field, $locale, $value)
      *
      * @param object $entity Must implement Translatable
      *
-     * @return array list of translations in locale groups
+     * @return array<string, array<string, string>> list of translations in locale groups
      */
     public function findTranslations($entity)
     {
@@ -199,7 +199,7 @@ public function findObjectByTranslatedField($field, $value, $class)
      *
      * @param mixed $id primary key value of an entity
      *
-     * @return array
+     * @return array<string, array<string, string>>
      */
     public function findTranslationsByObjectId($id)
     {

src/Translatable/Mapping/Event/TranslatableAdapter.php

@@ -49,7 +49,7 @@ public function getDefaultTranslationClass();
      * @phpstan-param class-string $translationClass
      * @phpstan-param class-string $objectClass
      *
-     * @return array
+     * @return array<int, array<string, mixed>>
      */
     public function loadTranslations($object, $translationClass, $locale, $objectClass);
 

src/Tree/Document/MongoDB/Repository/MaterializedPathRepository.php

@@ -73,7 +73,7 @@ public function getRootNodesQuery($sortByField = null, $direction = 'asc')
 
     public function getRootNodes($sortByField = null, $direction = 'asc')
     {
-        return $this->getRootNodesQuery($sortByField, $direction)->execute();
+        return $this->getRootNodesQuery($sortByField, $direction)->getIterator();
     }
 
     public function childCount($node = null, $direct = false)
@@ -137,7 +137,7 @@ public function getChildrenQueryBuilder($node = null, $direct = false, $sortByFi
             $qb->field($config['path'])->equals(new Regex($regex));
         }
 
-        $qb->sort($sortByField ?? $config['path'], 'asc' === $direction ? 'asc' : 'desc');
+        $qb->sort($sortByField ?? $config['path'], 'asc' === strtolower($direction) ? 'asc' : 'desc');
 
         return $qb;
     }
@@ -150,7 +150,7 @@ public function getChildrenQuery($node = null, $direct = false, $sortByField = n
         return $this->getChildrenQueryBuilder($node, $direct, $sortByField, $direction, $includeNode)->getQuery();
     }
 
-    public function getChildren($node = null, $direct = false, $sortByField = null, $direction = 'asc', $includeNode = false)
+    public function getChildren($node = null, $direct = false, $sortByField = null, $direction = 'ASC', $includeNode = false)
     {
         return $this->getChildrenQuery($node, $direct, $sortByField, $direction, $includeNode)->execute();
     }

src/Tree/Entity/Repository/AbstractTreeRepository.php

@@ -212,10 +212,12 @@ abstract public function getNodesHierarchyQuery($node = null, $direct = false, a
      * @param object|null          $node        If null, all tree nodes will be taken
      * @param bool                 $direct      True to take only direct children
      * @param string|string[]|null $sortByField Field name or array of fields names to sort by
-     * @param string|string[]      $direction   Sort order ('ASC'|'DESC'). If $sortByField is an array, this may also be an array with matching number of elements
+     * @param string|string[]      $direction   Sort order ('asc'|'desc'|'ASC'|'DESC'). If $sortByField is an array, this may also be an array with matching number of elements
      * @param bool                 $includeNode Include the root node in results?
      *
      * @return QueryBuilder QueryBuilder object
+     *
+     * @phpstan-param 'asc'|'desc'|'ASC'|'DESC'|array<int, 'asc'|'desc'|'ASC'|'DESC'> $direction
      */
     abstract public function getChildrenQueryBuilder($node = null, $direct = false, $sortByField = null, $direction = 'ASC', $includeNode = false);
 
@@ -225,10 +227,12 @@ abstract public function getChildrenQueryBuilder($node = null, $direct = false,
      * @param object|null          $node        If null, all tree nodes will be taken
      * @param bool                 $direct      True to take only direct children
      * @param string|string[]|null $sortByField Field name or array of fields names to sort by
-     * @param string|string[]      $direction   Sort order ('ASC'|'DESC'). If $sortByField is an array, this may also be an array with matching number of elements
+     * @param string|string[]      $direction   Sort order ('asc'|'desc'|'ASC'|'DESC'). If $sortByField is an array, this may also be an array with matching number of elements
      * @param bool                 $includeNode Include the root node in results?
      *
      * @return Query Query object
+     *
+     * @phpstan-param 'asc'|'desc'|'ASC'|'DESC'|array<int, 'asc'|'desc'|'ASC'|'DESC'> $direction
      */
     abstract public function getChildrenQuery($node = null, $direct = false, $sortByField = null, $direction = 'ASC', $includeNode = false);