Merge branch '2.5'

* 2.5:
  docs: better formatting in changelog
  Prepare release 2.5.10 (#3970)
  fix: only display hydra:next when the item total is strictly greater than the number of items per page (#3967)

Author: dunglas

.php_cs.dist

@@ -17,6 +17,10 @@ $finder = PhpCsFixer\Finder::create()
         'tests/Fixtures/app/var',
     ])
     ->notPath('src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php')
+    ->notPath('src/Annotation/ApiFilter.php') // temporary
+    ->notPath('src/Annotation/ApiProperty.php') // temporary
+    ->notPath('src/Annotation/ApiResource.php') // temporary
+    ->notPath('src/Annotation/ApiSubresource.php') // temporary
     ->notPath('tests/Fixtures/TestBundle/Entity/DummyPhp8.php') // temporary
     ->append([
         'tests/Fixtures/app/console',

CHANGELOG.md

@@ -59,6 +59,10 @@
 * Validator: Query filters and parameters are validated (#1723)
 * `ExceptionInterface` now extends `\Throwable` (#3217)
 
+## 2.5.10
+
+* Hydra: only display `hydra:next` when the item total is strictly greater than the number of items per page (#3967)
+
 ## 2.5.9
 
 * Fix a warning when preloading the `AbstractPaginator` class (#3827)

src/Annotation/ApiFilter.php

@@ -24,7 +24,7 @@
  * @Annotation
  * @Target({"PROPERTY", "CLASS"})
  */
-#[\Attribute(\Attribute::TARGET_PROPERTY|\Attribute::TARGET_CLASS|\Attribute::IS_REPEATABLE)]
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_CLASS | \Attribute::IS_REPEATABLE)]
 final class ApiFilter
 {
     /**

src/Annotation/ApiProperty.php

@@ -33,7 +33,7 @@
  *     @Attribute("swaggerContext", type="array")
  * )
  */
-#[\Attribute(\Attribute::TARGET_PROPERTY|\Attribute::TARGET_METHOD|\Attribute::TARGET_PARAMETER)]
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD | \Attribute::TARGET_PARAMETER)]
 final class ApiProperty
 {
     use AttributesHydratorTrait;

src/Annotation/ApiSubresource.php

@@ -21,7 +21,7 @@
  * @Annotation
  * @Target({"METHOD", "PROPERTY"})
  */
-#[\Attribute(\Attribute::TARGET_PROPERTY|\Attribute::TARGET_METHOD)]
+#[\Attribute(\Attribute::TARGET_PROPERTY | \Attribute::TARGET_METHOD)]
 final class ApiSubresource
 {
     /**

src/Annotation/AttributesHydratorTrait.php

@@ -72,7 +72,7 @@ private function hydrateAttributes(array $values): void
         foreach (self::$deprecatedAttributes as $deprecatedAttribute => $options) {
             if (\array_key_exists($deprecatedAttribute, $values)) {
                 $values[$options[0]] = $values[$deprecatedAttribute];
-                @trigger_error(sprintf('Attribute "%s" is deprecated in annotation since API Platform %s, prefer using "%s" attribute instead', $deprecatedAttribute, $options[1], $options[0]), E_USER_DEPRECATED);
+                @trigger_error(sprintf('Attribute "%s" is deprecated in annotation since API Platform %s, prefer using "%s" attribute instead', $deprecatedAttribute, $options[1], $options[0]), \E_USER_DEPRECATED);
                 unset($values[$deprecatedAttribute]);
             }
         }

src/Api/CachedIdentifiersExtractor.php

@@ -44,7 +44,7 @@ public function __construct(CacheItemPoolInterface $cacheItemPool, IdentifiersEx
         $this->resourceClassResolver = $resourceClassResolver;
 
         if (null === $this->resourceClassResolver) {
-            @trigger_error(sprintf('Not injecting %s in the CachedIdentifiersExtractor might introduce cache issues with object identifiers.', ResourceClassResolverInterface::class), E_USER_DEPRECATED);
+            @trigger_error(sprintf('Not injecting %s in the CachedIdentifiersExtractor might introduce cache issues with object identifiers.', ResourceClassResolverInterface::class), \E_USER_DEPRECATED);
         }
     }
 

src/Api/FilterCollection.php

@@ -26,7 +26,7 @@ final class FilterCollection extends \ArrayObject
 {
     public function __construct($input = [], $flags = 0, $iterator_class = 'ArrayIterator')
     {
-        @trigger_error(sprintf('The %s class is deprecated since version 2.1 and will be removed in 3.0. Provide an implementation of %s instead.', self::class, ContainerInterface::class), E_USER_DEPRECATED);
+        @trigger_error(sprintf('The %s class is deprecated since version 2.1 and will be removed in 3.0. Provide an implementation of %s instead.', self::class, ContainerInterface::class), \E_USER_DEPRECATED);
 
         parent::__construct($input, $flags, $iterator_class);
     }

src/Api/FilterLocatorTrait.php

@@ -36,7 +36,7 @@ private function setFilterLocator($filterLocator, bool $allowNull = false): void
     {
         if ($filterLocator instanceof ContainerInterface || $filterLocator instanceof FilterCollection || (null === $filterLocator && $allowNull)) {
             if ($filterLocator instanceof FilterCollection) {
-                @trigger_error(sprintf('The %s class is deprecated since version 2.1 and will be removed in 3.0. Provide an implementation of %s instead.', FilterCollection::class, ContainerInterface::class), E_USER_DEPRECATED);
+                @trigger_error(sprintf('The %s class is deprecated since version 2.1 and will be removed in 3.0. Provide an implementation of %s instead.', FilterCollection::class, ContainerInterface::class), \E_USER_DEPRECATED);
             }
 
             $this->filterLocator = $filterLocator;

src/Api/FormatsProvider.php

@@ -30,7 +30,7 @@ final class FormatsProvider implements FormatsProviderInterface, OperationAwareF
 
     public function __construct(ResourceMetadataFactoryInterface $resourceMetadataFactory, array $configuredFormats)
     {
-        @trigger_error(sprintf('The "%s" class is deprecated since API Platform 2.5, use the "formats" attribute instead.', __CLASS__), E_USER_DEPRECATED);
+        @trigger_error(sprintf('The "%s" class is deprecated since API Platform 2.5, use the "formats" attribute instead.', __CLASS__), \E_USER_DEPRECATED);
 
         $this->resourceMetadataFactory = $resourceMetadataFactory;
         $this->configuredFormats = $configuredFormats;

src/Api/IdentifiersExtractor.php

@@ -41,7 +41,7 @@ public function __construct(PropertyNameCollectionFactoryInterface $propertyName
         $this->resourceClassResolver = $resourceClassResolver;
 
         if (null === $this->resourceClassResolver) {
-            @trigger_error(sprintf('Not injecting %s in the IdentifiersExtractor might introduce cache issues with object identifiers.', ResourceClassResolverInterface::class), E_USER_DEPRECATED);
+            @trigger_error(sprintf('Not injecting %s in the IdentifiersExtractor might introduce cache issues with object identifiers.', ResourceClassResolverInterface::class), \E_USER_DEPRECATED);
         }
     }
 

src/Api/OperationTypeDeprecationHelper.php

@@ -34,7 +34,7 @@ final class OperationTypeDeprecationHelper
     public static function getOperationType($operationType): string
     {
         if (\is_bool($operationType)) {
-            @trigger_error('Using a boolean for the Operation Type is deprecated since API Platform 2.1 and will not be possible anymore in API Platform 3', E_USER_DEPRECATED);
+            @trigger_error('Using a boolean for the Operation Type is deprecated since API Platform 2.1 and will not be possible anymore in API Platform 3', \E_USER_DEPRECATED);
 
             $operationType = $operationType ? OperationType::COLLECTION : OperationType::ITEM;
         }

src/Bridge/Doctrine/Common/Filter/ExistsFilterTrait.php

@@ -75,7 +75,7 @@ private function normalizeValue($value, string $property): ?bool
         if (\is_array($value) && isset($value[self::QUERY_PARAMETER_KEY])) {
             @trigger_error(
                 sprintf('The ExistsFilter syntax "%s[exists]=true/false" is deprecated since 2.5. Use the syntax "%s[%s]=true/false" instead.', $property, $this->existsParameterName, $property),
-                E_USER_DEPRECATED
+                \E_USER_DEPRECATED
             );
             $value = $value[self::QUERY_PARAMETER_KEY];
         }

src/Bridge/Doctrine/Common/Filter/SearchFilterTrait.php

@@ -160,7 +160,7 @@ protected function normalizeValues(array $values, string $property): ?array
     protected function hasValidValues(array $values, $type = null): bool
     {
         foreach ($values as $key => $value) {
-            if (\in_array($type, (array) self::DOCTRINE_INTEGER_TYPE, true) && null !== $value && false === filter_var($value, FILTER_VALIDATE_INT)) {
+            if (null !== $value && \in_array($type, (array) self::DOCTRINE_INTEGER_TYPE, true) && false === filter_var($value, \FILTER_VALIDATE_INT)) {
                 return false;
             }
         }

src/Bridge/Doctrine/Common/PropertyHelperTrait.php

@@ -55,7 +55,7 @@ protected function isPropertyNested(string $property/*, string $resourceClass*/)
             if (__CLASS__ !== static::class) {
                 $r = new \ReflectionMethod($this, __FUNCTION__);
                 if (__CLASS__ !== $r->getDeclaringClass()->getName()) {
-                    @trigger_error(sprintf('Method %s() will have a second `$resourceClass` argument in version API Platform 3.0. Not defining it is deprecated since API Platform 2.1.', __FUNCTION__), E_USER_DEPRECATED);
+                    @trigger_error(sprintf('Method %s() will have a second `$resourceClass` argument in version API Platform 3.0. Not defining it is deprecated since API Platform 2.1.', __FUNCTION__), \E_USER_DEPRECATED);
                 }
             }
             $resourceClass = null;
@@ -94,7 +94,7 @@ protected function splitPropertyParts(string $property/*, string $resourceClass*
         } elseif (__CLASS__ !== static::class) {
             $r = new \ReflectionMethod($this, __FUNCTION__);
             if (__CLASS__ !== $r->getDeclaringClass()->getName()) {
-                @trigger_error(sprintf('Method %s() will have a second `$resourceClass` argument in version API Platform 3.0. Not defining it is deprecated since API Platform 2.1.', __FUNCTION__), E_USER_DEPRECATED);
+                @trigger_error(sprintf('Method %s() will have a second `$resourceClass` argument in version API Platform 3.0. Not defining it is deprecated since API Platform 2.1.', __FUNCTION__), \E_USER_DEPRECATED);
             }
         }
 

src/Bridge/Doctrine/EventListener/PublishMercureUpdatesListener.php

@@ -41,6 +41,8 @@
  */
 final class PublishMercureUpdatesListener
 {
+    use DispatchTrait;
+    use ResourceClassInfoTrait;
     private const ALLOWED_KEYS = [
         'topics' => true,
         'data' => true,
@@ -51,9 +53,6 @@ final class PublishMercureUpdatesListener
         'normalization_context' => true,
     ];
 
-    use DispatchTrait;
-    use ResourceClassInfoTrait;
-
     private $iriConverter;
     private $serializer;
     private $publisher;
@@ -182,7 +181,7 @@ private function storeObjectToPublish($object, string $property): void
                     throw new \InvalidArgumentException('Targets do not exist anymore since Mercure 0.10. Mark the update as private instead or downgrade the Mercure Component to version 0.3');
                 }
 
-                @trigger_error('Targets do not exist anymore since Mercure 0.10. Mark the update as private instead.', E_USER_DEPRECATED);
+                @trigger_error('Targets do not exist anymore since Mercure 0.10. Mark the update as private instead.', \E_USER_DEPRECATED);
                 break;
             }
 

src/Bridge/Doctrine/EventListener/WriteListener.php

@@ -31,7 +31,7 @@ final class WriteListener
 
     public function __construct(ManagerRegistry $managerRegistry)
     {
-        @trigger_error(sprintf('The %s class is deprecated since version 2.2 and will be removed in 3.0. Use the %s class instead.', __CLASS__, BaseWriteListener::class), E_USER_DEPRECATED);
+        @trigger_error(sprintf('The %s class is deprecated since version 2.2 and will be removed in 3.0. Use the %s class instead.', __CLASS__, BaseWriteListener::class), \E_USER_DEPRECATED);
 
         $this->managerRegistry = $managerRegistry;
     }

src/Bridge/Doctrine/MongoDbOdm/SubresourceDataProvider.php

@@ -127,7 +127,7 @@ private function buildAggregation(array $identifiers, array $context, array $exe
             $identifierResourceClass = $context['identifiers'][$identifier][0];
             $previousAssociationProperty = $contextIdentifiers[$remainingIdentifiers] ?? $context['property'];
         } else {
-            @trigger_error('Identifiers should match the convention introduced in ADR 0001-resource-identifiers, this behavior will be removed in 3.0.', E_USER_DEPRECATED);
+            @trigger_error('Identifiers should match the convention introduced in ADR 0001-resource-identifiers, this behavior will be removed in 3.0.', \E_USER_DEPRECATED);
             [$identifier, $identifierResourceClass] = $context['identifiers'][$remainingIdentifiers - 1];
             $previousAssociationProperty = $context['identifiers'][$remainingIdentifiers][0] ?? $context['property'];
         }

src/Bridge/Doctrine/Orm/Extension/EagerLoadingExtension.php

@@ -55,10 +55,10 @@ final class EagerLoadingExtension implements ContextAwareQueryCollectionExtensio
     public function __construct(PropertyNameCollectionFactoryInterface $propertyNameCollectionFactory, PropertyMetadataFactoryInterface $propertyMetadataFactory, ResourceMetadataFactoryInterface $resourceMetadataFactory, int $maxJoins = 30, bool $forceEager = true, RequestStack $requestStack = null, SerializerContextBuilderInterface $serializerContextBuilder = null, bool $fetchPartial = false, ClassMetadataFactoryInterface $classMetadataFactory = null)
     {
         if (null !== $this->requestStack) {
-            @trigger_error(sprintf('Passing an instance of "%s" is deprecated since version 2.2 and will be removed in 3.0. Use the data provider\'s context instead.', RequestStack::class), E_USER_DEPRECATED);
+            @trigger_error(sprintf('Passing an instance of "%s" is deprecated since version 2.2 and will be removed in 3.0. Use the data provider\'s context instead.', RequestStack::class), \E_USER_DEPRECATED);
         }
         if (null !== $this->serializerContextBuilder) {
-            @trigger_error(sprintf('Passing an instance of "%s" is deprecated since version 2.2 and will be removed in 3.0. Use the data provider\'s context instead.', SerializerContextBuilderInterface::class), E_USER_DEPRECATED);
+            @trigger_error(sprintf('Passing an instance of "%s" is deprecated since version 2.2 and will be removed in 3.0. Use the data provider\'s context instead.', SerializerContextBuilderInterface::class), \E_USER_DEPRECATED);
         }
 
         $this->propertyNameCollectionFactory = $propertyNameCollectionFactory;
@@ -178,7 +178,7 @@ private function joinRelations(QueryBuilder $queryBuilder, QueryNameGeneratorInt
                 (null === $fetchEager = $propertyMetadata->getAttribute('fetch_eager')) &&
                 (null !== $fetchEager = $propertyMetadata->getAttribute('fetchEager'))
             ) {
-                @trigger_error('The "fetchEager" attribute is deprecated since 2.3. Please use "fetch_eager" instead.', E_USER_DEPRECATED);
+                @trigger_error('The "fetchEager" attribute is deprecated since 2.3. Please use "fetch_eager" instead.', \E_USER_DEPRECATED);
             }
 
             if (false === $fetchEager) {

src/Bridge/Doctrine/Orm/Extension/PaginationExtension.php

@@ -68,8 +68,8 @@ final class PaginationExtension implements ContextAwareQueryResultCollectionExte
     public function __construct(ManagerRegistry $managerRegistry, /* ResourceMetadataFactoryInterface */ $resourceMetadataFactory, /* Pagination */ $pagination)
     {
         if ($resourceMetadataFactory instanceof RequestStack && $pagination instanceof ResourceMetadataFactoryInterface) {
-            @trigger_error(sprintf('Passing an instance of "%s" as second argument of "%s" is deprecated since API Platform 2.4 and will not be possible anymore in API Platform 3. Pass an instance of "%s" instead.', RequestStack::class, self::class, ResourceMetadataFactoryInterface::class), E_USER_DEPRECATED);
-            @trigger_error(sprintf('Passing an instance of "%s" as third argument of "%s" is deprecated since API Platform 2.4 and will not be possible anymore in API Platform 3. Pass an instance of "%s" instead.', ResourceMetadataFactoryInterface::class, self::class, Pagination::class), E_USER_DEPRECATED);
+            @trigger_error(sprintf('Passing an instance of "%s" as second argument of "%s" is deprecated since API Platform 2.4 and will not be possible anymore in API Platform 3. Pass an instance of "%s" instead.', RequestStack::class, self::class, ResourceMetadataFactoryInterface::class), \E_USER_DEPRECATED);
+            @trigger_error(sprintf('Passing an instance of "%s" as third argument of "%s" is deprecated since API Platform 2.4 and will not be possible anymore in API Platform 3. Pass an instance of "%s" instead.', ResourceMetadataFactoryInterface::class, self::class, Pagination::class), \E_USER_DEPRECATED);
 
             $this->requestStack = $resourceMetadataFactory;
             $resourceMetadataFactory = $pagination;
@@ -92,7 +92,7 @@ public function __construct(ManagerRegistry $managerRegistry, /* ResourceMetadat
 
             foreach ($legacyPaginationArgs as $pos => $arg) {
                 if (\array_key_exists($pos, $args)) {
-                    @trigger_error(sprintf('Passing "$%s" arguments is deprecated since API Platform 2.4 and will not be possible anymore in API Platform 3. Pass an instance of "%s" as third argument instead.', implode('", "$', array_column($legacyPaginationArgs, 'arg_name')), Paginator::class), E_USER_DEPRECATED);
+                    @trigger_error(sprintf('Passing "$%s" arguments is deprecated since API Platform 2.4 and will not be possible anymore in API Platform 3. Pass an instance of "%s" as third argument instead.', implode('", "$', array_column($legacyPaginationArgs, 'arg_name')), Paginator::class), \E_USER_DEPRECATED);
 
                     if (!((null === $arg['default'] && null === $args[$pos]) || \call_user_func("is_{$arg['type']}", $args[$pos]))) {
                         throw new InvalidArgumentException(sprintf('The "$%s" argument is expected to be a %s%s.', $arg['arg_name'], $arg['type'], null === $arg['default'] ? ' or null' : ''));
@@ -224,7 +224,7 @@ private function getPagination(QueryBuilder $queryBuilder, string $resourceClass
             $maxItemsPerPage = $resourceMetadata->getCollectionOperationAttribute($operationName, 'maximum_items_per_page', null, true);
 
             if (null !== $maxItemsPerPage) {
-                @trigger_error('The "maximum_items_per_page" option has been deprecated since API Platform 2.5 in favor of "pagination_maximum_items_per_page" and will be removed in API Platform 3.', E_USER_DEPRECATED);
+                @trigger_error('The "maximum_items_per_page" option has been deprecated since API Platform 2.5 in favor of "pagination_maximum_items_per_page" and will be removed in API Platform 3.', \E_USER_DEPRECATED);
             }
 
             $maxItemsPerPage = $resourceMetadata->getCollectionOperationAttribute($operationName, 'pagination_maximum_items_per_page', $maxItemsPerPage ?? $this->maximumItemPerPage, true);
@@ -274,7 +274,7 @@ private function isPartialPaginationEnabled(Request $request = null, ResourceMet
         }
 
         if ($clientEnabled && $request) {
-            $enabled = filter_var($this->getPaginationParameter($request, $this->partialParameterName, $enabled), FILTER_VALIDATE_BOOLEAN);
+            $enabled = filter_var($this->getPaginationParameter($request, $this->partialParameterName, $enabled), \FILTER_VALIDATE_BOOLEAN);
         }
 
         return $enabled;
@@ -286,7 +286,7 @@ private function isPaginationEnabled(Request $request, ResourceMetadata $resourc
         $clientEnabled = $resourceMetadata->getCollectionOperationAttribute($operationName, 'pagination_client_enabled', $this->clientEnabled, true);
 
         if ($clientEnabled) {
-            $enabled = filter_var($this->getPaginationParameter($request, $this->enabledParameterName, $enabled), FILTER_VALIDATE_BOOLEAN);
+            $enabled = filter_var($this->getPaginationParameter($request, $this->enabledParameterName, $enabled), \FILTER_VALIDATE_BOOLEAN);
         }
 
         return $enabled;