chore: deprecate ApiPlatform\Api\FilterInterface (#6312)

api-platform · Apr 15, 2024 · 9fee836 · 9fee836
1 parent 1a120ee
commit 9fee836
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 5 deletions.
diff --git a/docs/guides/create-a-custom-doctrine-filter.php b/docs/guides/create-a-custom-doctrine-filter.php
@@ -7,7 +7,7 @@
 // tags: doctrine, expert
 // ---
 
-// Custom filters can be written by implementing the `ApiPlatform\Api\FilterInterface` interface.
+// Custom filters can be written by implementing the `ApiPlatform\Metadata\FilterInterface` interface.
 //
 // API Platform provides a convenient way to create Doctrine ORM and MongoDB ODM filters. If you use [custom state providers](/docs/guide/state-providers), you can still create filters by implementing the previously mentioned interface, but - as API Platform isn't aware of your persistence system's internals - you have to create the filtering logic by yourself.
 //

diff --git a/src/Api/FilterInterface.php b/src/Api/FilterInterface.php
@@ -17,6 +17,8 @@
  * Filters applicable on a resource.
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
+ *
+ * @deprecated
  */
 interface FilterInterface
 {

diff --git a/src/ParameterValidator/Validator/ValidatorInterface.php b/src/ParameterValidator/Validator/ValidatorInterface.php
@@ -17,7 +17,7 @@ interface ValidatorInterface
 {
     /**
      * @param string               $name              the parameter name to validate
-     * @param array<string, mixed> $filterDescription the filter descriptions as returned by `\ApiPlatform\Api\FilterInterface::getDescription()`
+     * @param array<string, mixed> $filterDescription the filter descriptions as returned by `\ApiPlatform\Metadata\FilterInterface::getDescription()`
      * @param array<string, mixed> $queryParameters   the list of query parameter
      */
     public function validate(string $name, array $filterDescription, array $queryParameters): array;

diff --git a/tests/Fixtures/DummyFilter.php b/tests/Fixtures/DummyFilter.php
@@ -13,7 +13,7 @@
 
 namespace ApiPlatform\Tests\Fixtures;
 
-use ApiPlatform\Api\FilterInterface;
+use ApiPlatform\Metadata\FilterInterface;
 
 /**
  * @author Kévin Dunglas <dunglas@gmail.com>

diff --git a/tests/Fixtures/TestBundle/Filter/NoConstructorFilter.php b/tests/Fixtures/TestBundle/Filter/NoConstructorFilter.php
@@ -13,7 +13,7 @@
 
 namespace ApiPlatform\Tests\Fixtures\TestBundle\Filter;
 
-use ApiPlatform\Api\FilterInterface;
+use ApiPlatform\Metadata\FilterInterface;
 
 final class NoConstructorFilter implements FilterInterface
 {

diff --git a/tests/Fixtures/TestBundle/Filter/NoPropertiesArgumentFilter.php b/tests/Fixtures/TestBundle/Filter/NoPropertiesArgumentFilter.php
@@ -13,7 +13,7 @@
 
 namespace ApiPlatform\Tests\Fixtures\TestBundle\Filter;
 
-use ApiPlatform\Api\FilterInterface;
+use ApiPlatform\Metadata\FilterInterface;
 
 final class NoPropertiesArgumentFilter implements FilterInterface
 {