Merge remote-tracking branch 'origin/3.4.x' into 4.0.x

.github/workflows/coding-standards.yml

@@ -24,4 +24,4 @@ on:
 
 jobs:
   coding-standards:
-    uses: "doctrine/.github/.github/workflows/coding-standards.yml@6.0.0"
+    uses: "doctrine/.github/.github/workflows/coding-standards.yml@7.2.1"

.github/workflows/documentation.yml

@@ -17,4 +17,4 @@ on:
 jobs:
   documentation:
     name: "Documentation"
-    uses: "doctrine/.github/.github/workflows/documentation.yml@6.0.0"
+    uses: "doctrine/.github/.github/workflows/documentation.yml@7.2.1"

.github/workflows/release-on-milestone-closed.yml

@@ -7,7 +7,7 @@ on:
 
 jobs:
   release:
-    uses: "doctrine/.github/.github/workflows/release-on-milestone-closed.yml@6.0.0"
+    uses: "doctrine/.github/.github/workflows/release-on-milestone-closed.yml@7.2.1"
     secrets:
       GIT_AUTHOR_EMAIL: ${{ secrets.GIT_AUTHOR_EMAIL }}
       GIT_AUTHOR_NAME: ${{ secrets.GIT_AUTHOR_NAME }}

.github/workflows/website-schema.yml

@@ -0,0 +1,21 @@
+
+name: "Website config validation"
+
+on:
+  pull_request:
+    branches:
+      - "*.x"
+    paths:
+      - ".doctrine-project.json"
+      - ".github/workflows/website-schema.yml"
+  push:
+    branches:
+      - "*.x"
+    paths:
+      - ".doctrine-project.json"
+      - ".github/workflows/website-schema.yml"
+
+jobs:
+  json-validate:
+    name: "Validate JSON schema"
+    uses: "doctrine/.github/.github/workflows/[email protected]"

UPGRADE.md

@@ -180,6 +180,36 @@ WARNING: This was relaxed in ORM 3.2 when partial was re-allowed for array-hydra
   `Doctrine\ORM\Query::HINT_FORCE_PARTIAL_LOAD` are removed.
 - `Doctrine\ORM\EntityManager*::getPartialReference()` is removed.
 
+## BC BREAK: Enforce ArrayCollection Type on `\Doctrine\ORM\QueryBuilder::setParameters(ArrayCollection $parameters)` 
+
+The argument $parameters can no longer be a key=>value array. Only ArrayCollection types are allowed.
+
+### Before
+
+```php
+$qb = $em->createQueryBuilder()
+    ->select('u')
+    ->from('User', 'u')
+    ->where('u.id = :user_id1 OR u.id = :user_id2')
+    ->setParameters(array(
+        'user_id1' => 1,
+        'user_id2' => 2
+    ));
+```
+
+### After
+
+```php
+$qb = $em->createQueryBuilder()
+    ->select('u')
+    ->from('User', 'u')
+    ->where('u.id = :user_id1 OR u.id = :user_id2')
+    ->setParameters(new ArrayCollection(array(
+        new Parameter('user_id1', 1),
+        new Parameter('user_id2', 2)
+    )));
+```
+
 ## BC BREAK: `Doctrine\ORM\Persister\Entity\EntityPersister::executeInserts()` return type changed to `void`
 
 Implementors should adapt to the new signature, and should call

docs/en/reference/association-mapping.rst

@@ -903,8 +903,7 @@ defaults to "id", just as in one-to-one or many-to-one mappings.
 
 Additionally, when using typed properties with Doctrine 2.9 or newer
 you can skip ``targetEntity`` in ``ManyToOne`` and ``OneToOne``
-associations as they will be set based on type. Also ``nullable``
-attribute on ``JoinColumn`` will be inherited from PHP type. So that:
+associations as they will be set based on type. So that:
 
 .. configuration-block::
 
@@ -931,7 +930,7 @@ Is essentially the same as following:
         <?php
         /** One Product has One Shipment. */
         #[OneToOne(targetEntity: Shipment::class)]
-        #[JoinColumn(name: 'shipment_id', referencedColumnName: 'id', nullable: false)]
+        #[JoinColumn(name: 'shipment_id', referencedColumnName: 'id')]
         private Shipment $shipment;
 
     .. code-block:: annotation
@@ -940,7 +939,7 @@ Is essentially the same as following:
         /**
          * One Product has One Shipment.
          * @OneToOne(targetEntity="Shipment")
-         * @JoinColumn(name="shipment_id", referencedColumnName="id", nullable=false)
+         * @JoinColumn(name="shipment_id", referencedColumnName="id")
          */
         private Shipment $shipment;
 

docs/en/reference/basic-mapping.rst

@@ -167,6 +167,7 @@ Here is a complete list of ``Column``s attributes (all optional):
 - ``nullable`` (default: ``false``): Whether the column is nullable.
 - ``insertable`` (default: ``true``): Whether the column should be inserted.
 - ``updatable`` (default: ``true``): Whether the column should be updated.
+- ``generated`` (default: ``null``): Whether the generated strategy should be ``'NEVER'``, ``'INSERT'`` and ``ALWAYS``.
 - ``enumType`` (requires PHP 8.1 and ``doctrine/orm`` 2.11): The PHP enum class name to convert the database value into.
 - ``precision`` (default: 0): The precision for a decimal (exact numeric) column
   (applies only for decimal column),

docs/en/reference/inheritance-mapping.rst

@@ -16,7 +16,7 @@ is common to multiple entity classes.
 Mapped superclasses, just as regular, non-mapped classes, can
 appear in the middle of an otherwise mapped inheritance hierarchy
 (through Single Table Inheritance or Class Table Inheritance). They
-are not query-able, and need not have an ``#[Id]`` property.
+are not query-able, and do not require an ``#[Id]`` property.
 
 No database table will be created for a mapped superclass itself,
 only for entity classes inheriting from it. That  implies that a

docs/en/reference/working-with-objects.rst

@@ -166,7 +166,7 @@ your code. See the following code:
 
     Traversing the object graph for parts that are lazy-loaded will
     easily trigger lots of SQL queries and will perform badly if used
-    to heavily. Make sure to use DQL to fetch-join all the parts of the
+    too heavily. Make sure to use DQL to fetch-join all the parts of the
     object-graph that you need as efficiently as possible.
 
 

docs/en/tutorials/composite-primary-keys.rst

@@ -85,11 +85,12 @@ And for querying you can use arrays to both DQL and EntityRepositories:
     namespace VehicleCatalogue\Model;
 
     // $em is the EntityManager
-    $audi = $em->find("VehicleCatalogue\Model\Car", array("name" => "Audi A8", "year" => 2010));
+    $audi = $em->find("VehicleCatalogue\Model\Car", ["name" => "Audi A8", "year" => 2010]);
 
-    $dql = "SELECT c FROM VehicleCatalogue\Model\Car c WHERE c.id = ?1";
+    $dql = "SELECT c FROM VehicleCatalogue\Model\Car c WHERE c.name = ?1 AND c.year = ?2";
     $audi = $em->createQuery($dql)
-               ->setParameter(1, ["name" => "Audi A8", "year" => 2010])
+               ->setParameter(1, "Audi A8")
+               ->setParameter(2, 2010)
                ->getSingleResult();
 
 You can also use this entity in associations. Doctrine will then generate two foreign keys one for ``name``

docs/en/tutorials/override-field-association-mappings-in-subclasses.rst

@@ -9,30 +9,28 @@ i.e. attributes and associations metadata in particular. The example here shows
 the overriding of a class that uses a trait but is similar when extending a base
 class as shown at the end of this tutorial.
 
-Suppose we have a class ExampleEntityWithOverride. This class uses trait ExampleTrait:
+Suppose we have a class ``ExampleEntityWithOverride``. This class uses trait ``ExampleTrait``:
 
 .. code-block:: php
 
     <?php
 
     #[Entity]
     #[AttributeOverrides([
-        new AttributeOverride('foo', [
-            'column' => new Column([
-                'name' => 'foo_overridden',
-                'type' => 'integer',
-                'length' => 140,
-                'nullable' => false,
-                'unique' => false,
-            ]),
-        ]),
+        new AttributeOverride('foo', new Column(
+            name: 'foo_overridden',
+            type: 'integer',
+            length: 140,
+            nullable: false,
+            unique: false,
+        )),
     ])]
     #[AssociationOverrides([
         new AssociationOverride('bar', [
-            'joinColumns' => new JoinColumn([
-                'name' => 'example_entity_overridden_bar_id',
-                'referencedColumnName' => 'id',
-            ]),
+            new JoinColumn(
+                name: 'example_entity_overridden_bar_id',
+                referencedColumnName: 'id',
+            ),
         ]),
     ])]
     class ExampleEntityWithOverride
@@ -47,7 +45,7 @@ Suppose we have a class ExampleEntityWithOverride. This class uses trait Example
         private $id;
     }
 
-The docblock is showing metadata override of the attribute and association type. It
+``#[AttributeOverrides]`` contains metadata override of the attribute and association type. It
 basically changes the names of the columns mapped for a property ``foo`` and for
 the association ``bar`` which relates to Bar class shown above. Here is the trait
 which has mapping metadata that is overridden by the attribute above:

phpcs.xml.dist

@@ -1,5 +1,7 @@
 <?xml version="1.0"?>
-<ruleset>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         name="PHP_CodeSniffer"
+         xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
     <arg name="basepath" value="."/>
     <arg name="extensions" value="php"/>
     <arg name="parallel" value="80"/>

phpunit.xml.dist

@@ -14,6 +14,7 @@
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
          colors="true"
+         displayDetailsOnTestsThatTriggerDeprecations="true"
          displayDetailsOnTestsThatTriggerNotices="true"
          displayDetailsOnTestsThatTriggerWarnings="true"
          failOnNotice="true"
@@ -67,5 +68,12 @@
         <var name="privileged_db_port" value="3306"/>
         -->
         <env name="COLUMNS" value="120"/>
+        <env name="DOCTRINE_DEPRECATIONS" value="trigger"/>
     </php>
+
+    <source ignoreSuppressionOfDeprecations="true">
+        <include>
+            <directory>src</directory>
+        </include>
+    </source>
 </phpunit>

src/Cache/CollectionCacheKey.php

@@ -29,11 +29,14 @@ public function __construct(
         public readonly string $entityClass,
         public readonly string $association,
         array $ownerIdentifier,
+        string $filterHash = '',
     ) {
         ksort($ownerIdentifier);
 
         $this->ownerIdentifier = $ownerIdentifier;
 
-        parent::__construct(str_replace('\\', '.', strtolower($entityClass)) . '_' . implode(' ', $ownerIdentifier) . '__' . $association);
+        $filterHash = $filterHash === '' ? '' : '_' . $filterHash;
+
+        parent::__construct(str_replace('\\', '.', strtolower($entityClass)) . '_' . implode(' ', $ownerIdentifier) . '__' . $association . $filterHash);
     }
 }

src/Cache/Persister/Collection/AbstractCollectionPersister.php

@@ -18,6 +18,7 @@
 use Doctrine\ORM\PersistentCollection;
 use Doctrine\ORM\Persisters\Collection\CollectionPersister;
 use Doctrine\ORM\Proxy\DefaultProxyClassNameResolver;
+use Doctrine\ORM\Query\FilterCollection;
 use Doctrine\ORM\UnitOfWork;
 
 use function array_values;
@@ -35,6 +36,7 @@ abstract class AbstractCollectionPersister implements CachedCollectionPersister
     protected array $queuedCache = [];
 
     protected string $regionName;
+    protected FilterCollection $filters;
     protected CollectionHydrator $hydrator;
     protected CacheLogger|null $cacheLogger;
 
@@ -48,6 +50,10 @@ public function __construct(
         $cacheConfig   = $configuration->getSecondLevelCacheConfiguration();
         $cacheFactory  = $cacheConfig->getCacheFactory();
 
+        $this->region          = $region;
+        $this->persister       = $persister;
+        $this->association     = $association;
+        $this->filters         = $em->getFilters();
         $this->regionName      = $region->getName();
         $this->uow             = $em->getUnitOfWork();
         $this->metadataFactory = $em->getMetadataFactory();
@@ -135,7 +141,7 @@ public function containsKey(PersistentCollection $collection, mixed $key): bool
     public function count(PersistentCollection $collection): int
     {
         $ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
-        $key     = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association->fieldName, $ownerId);
+        $key     = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association->fieldName, $ownerId, $this->filters->getHash());
         $entry   = $this->region->get($key);
 
         if ($entry !== null) {

src/Cache/Persister/Collection/NonStrictReadWriteCachedCollectionPersister.php

@@ -36,7 +36,7 @@ public function afterTransactionRolledBack(): void
     public function delete(PersistentCollection $collection): void
     {
         $ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
-        $key     = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association->fieldName, $ownerId);
+        $key     = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association->fieldName, $ownerId, $this->filters->getHash());
 
         $this->persister->delete($collection);
 
@@ -53,7 +53,7 @@ public function update(PersistentCollection $collection): void
         }
 
         $ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
-        $key     = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association->fieldName, $ownerId);
+        $key     = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association->fieldName, $ownerId, $this->filters->getHash());
 
        // Invalidate non initialized collections OR ordered collection
         if ($isDirty && ! $isInitialized || $this->association->isOrdered()) {

src/Cache/Persister/Collection/ReadWriteCachedCollectionPersister.php

@@ -61,7 +61,7 @@ public function afterTransactionRolledBack(): void
     public function delete(PersistentCollection $collection): void
     {
         $ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
-        $key     = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association->fieldName, $ownerId);
+        $key     = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association->fieldName, $ownerId, $this->filters->getHash());
         $lock    = $this->region->lock($key);
 
         $this->persister->delete($collection);
@@ -88,7 +88,7 @@ public function update(PersistentCollection $collection): void
         $this->persister->update($collection);
 
         $ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
-        $key     = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association->fieldName, $ownerId);
+        $key     = new CollectionCacheKey($this->sourceEntity->rootEntityName, $this->association->fieldName, $ownerId, $this->filters->getHash());
         $lock    = $this->region->lock($key);
 
         if ($lock === null) {

src/Cache/Persister/Entity/AbstractEntityPersister.php

@@ -24,10 +24,12 @@
 use Doctrine\ORM\PersistentCollection;
 use Doctrine\ORM\Persisters\Entity\EntityPersister;
 use Doctrine\ORM\Proxy\DefaultProxyClassNameResolver;
+use Doctrine\ORM\Query\FilterCollection;
 use Doctrine\ORM\Query\ResultSetMapping;
 use Doctrine\ORM\UnitOfWork;
 
 use function array_merge;
+use function func_get_args;
 use function serialize;
 use function sha1;
 
@@ -43,6 +45,7 @@ abstract class AbstractEntityPersister implements CachedEntityPersister
     protected TimestampCacheKey $timestampKey;
     protected EntityHydrator $hydrator;
     protected Cache $cache;
+    protected FilterCollection $filters;
     protected CacheLogger|null $cacheLogger = null;
     protected string $regionName;
 
@@ -64,6 +67,7 @@ public function __construct(
         $cacheFactory  = $cacheConfig->getCacheFactory();
 
         $this->cache           = $em->getCache();
+        $this->filters         = $em->getFilters();
         $this->regionName      = $region->getName();
         $this->uow             = $em->getUnitOfWork();
         $this->metadataFactory = $em->getMetadataFactory();
@@ -215,7 +219,7 @@ protected function getHash(
             ? $this->persister->expandCriteriaParameters($criteria)
             : $this->persister->expandParameters($criteria);
 
-        return sha1($query . serialize($params) . serialize($orderBy) . $limit . $offset);
+        return sha1($query . serialize($params) . serialize($orderBy) . $limit . $offset . $this->filters->getHash());
     }
 
     /**
@@ -472,7 +476,7 @@ public function loadManyToManyCollection(
         }
 
         $ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
-        $key     = $this->buildCollectionCacheKey($assoc, $ownerId);
+        $key     = $this->buildCollectionCacheKey($assoc, $ownerId, $this->filters->getHash());
         $list    = $persister->loadCollectionCache($collection, $key);
 
         if ($list !== null) {
@@ -503,7 +507,7 @@ public function loadOneToManyCollection(
         }
 
         $ownerId = $this->uow->getEntityIdentifier($collection->getOwner());
-        $key     = $this->buildCollectionCacheKey($assoc, $ownerId);
+        $key     = $this->buildCollectionCacheKey($assoc, $ownerId, $this->filters->getHash());
         $list    = $persister->loadCollectionCache($collection, $key);
 
         if ($list !== null) {
@@ -546,12 +550,15 @@ public function refresh(array $id, object $entity, LockMode|null $lockMode = nul
     }
 
     /** @param array<string, mixed> $ownerId */
-    protected function buildCollectionCacheKey(AssociationMapping $association, array $ownerId): CollectionCacheKey
+    protected function buildCollectionCacheKey(AssociationMapping $association, array $ownerId, /* string $filterHash */): CollectionCacheKey
     {
+        $filterHash = (string) (func_get_args()[2] ?? ''); // todo: move to argument in next major release
+
         return new CollectionCacheKey(
             $this->metadataFactory->getMetadataFor($association->sourceEntity)->rootEntityName,
             $association->fieldName,
             $ownerId,
+            $filterHash,
         );
     }
 }