add comments

src/Doctrine/Orm/Extension/ParameterExtension.php

@@ -22,6 +22,8 @@
 use Psr\Container\ContainerInterface;
 
 /**
+ * Reads operation parameters and execute its filter.
+ *
  * @author Antoine Bluchet <soyuka@gmail.com>
  */
 final class ParameterExtension implements QueryCollectionExtensionInterface, QueryItemExtensionInterface
@@ -47,7 +49,6 @@ private function applyFilter(QueryBuilder $queryBuilder, QueryNameGeneratorInter
             }
 
             $parameters = $parameter instanceof HeaderParameterInterface ? $request->attributes->get('_api_header_parameters') : $request->attributes->get('_api_query_parameters');
-
             $parsedKey = explode('[:property]', $key);
             if (isset($parsedKey[0]) && isset($parameters[$parsedKey[0]])) {
                 $key = $parsedKey[0];

src/Doctrine/Orm/Filter/AbstractFilter.php

@@ -29,7 +29,7 @@ abstract class AbstractFilter implements FilterInterface
     use PropertyHelperTrait;
     protected LoggerInterface $logger;
 
-    public function __construct(protected ManagerRegistry $managerRegistry, ?LoggerInterface $logger = null, public ?array $properties = null, protected ?NameConverterInterface $nameConverter = null)
+    public function __construct(protected ManagerRegistry $managerRegistry, ?LoggerInterface $logger = null, protected ?array $properties = null, protected ?NameConverterInterface $nameConverter = null)
     {
         $this->logger = $logger ?? new NullLogger();
     }
@@ -64,6 +64,14 @@ protected function getLogger(): LoggerInterface
         return $this->logger;
     }
 
+    /**
+     * @param string[] $properties
+     */
+    public function setProperties(array $properties): void
+    {
+        $this->properties = $properties;
+    }
+
     /**
      * Determines whether the given property is enabled.
      */

src/Hydra/Serializer/CollectionFiltersNormalizer.php

@@ -175,6 +175,7 @@ private function getSearch(string $resourceClass, array $parts, array $filters,
                         continue;
                     }
 
+                    // :property is a pattern allowed when defining parameters
                     $k = str_replace(':property', $description['property'], $key);
                     $variable = str_replace($description['property'], $k, $variable);
                     $variables[] = $variable;

src/Metadata/ApiFilter.php

@@ -26,7 +26,7 @@ final class ApiFilter
 {
     /**
      * @param string|class-string<FilterInterface>|class-string<LegacyFilterInterface> $filterClass
-     * @param string                                                                   $alias       a service alias to be referenced in a Parameter
+     * @param string                                                                   $alias       a filter tag alias to be referenced in a Parameter
      */
     public function __construct(
         public string $filterClass,

src/Metadata/Parameters.php

@@ -14,7 +14,7 @@
 namespace ApiPlatform\Metadata;
 
 /**
- * An parameter dictionnary.
+ * A parameter dictionnary.
  *
  * @implements \IteratorAggregate<string, Parameter>
  */

src/Metadata/Resource/Factory/ParameterResourceMetadataCollectionFactory.php

@@ -22,6 +22,8 @@
 use Psr\Container\ContainerInterface;
 
 /**
+ * Prepares Parameters documentation by reading its filter details and declaring an OpenApi parameter.
+ *
  * @experimental
  */
 final class ParameterResourceMetadataCollectionFactory implements ResourceMetadataCollectionFactoryInterface

tests/Fixtures/TestBundle/Filter/SearchFilterValueTransformer.php

@@ -23,7 +23,7 @@ final class SearchFilterValueTransformer implements FilterInterface
 {
     public function __construct(#[Autowire('@api_platform.doctrine.orm.search_filter.instance')] readonly FilterInterface $searchFilter, ?array $properties = null, private readonly ?string $key = null)
     {
-        $searchFilter->properties = $properties;
+        $searchFilter->setProperties($properties);
     }
 
     // This function is only used to hook in documentation generators (supported by Swagger and Hydra)

tests/Fixtures/TestBundle/Filter/SearchTextAndDateFilter.php

@@ -21,10 +21,10 @@
 
 final class SearchTextAndDateFilter implements FilterInterface
 {
-    public function __construct(#[Autowire('@api_platform.doctrine.orm.search_filter.instance')] readonly FilterInterface $searchFilter, #[Autowire('@api_platform.doctrine.orm.date_filter.instance')] readonly FilterInterface $dateFilter, ?array $properties = null, array $dateFilterProperties = [], array $searchFilterProperties = [])
+    public function __construct(#[Autowire('@api_platform.doctrine.orm.search_filter.instance')] readonly FilterInterface $searchFilter, #[Autowire('@api_platform.doctrine.orm.date_filter.instance')] readonly FilterInterface $dateFilter, protected ?array $properties = null, array $dateFilterProperties = [], array $searchFilterProperties = [])
     {
-        $searchFilter->properties = $searchFilterProperties;
-        $dateFilter->properties = $dateFilterProperties;
+        $searchFilter->setProperties($searchFilterProperties);
+        $dateFilter->setProperties($dateFilterProperties);
     }
 
     // This function is only used to hook in documentation generators (supported by Swagger and Hydra)