feat(doctrine): deprecate AbstractFilter base class#8330
Merged
soyuka merged 1 commit intoJun 17, 2026
Conversation
Mark the ORM and ODM Doctrine AbstractFilter base classes as @deprecated since 4.4. Third parties extending AbstractFilter should implement ApiPlatform\Metadata\FilterInterface directly together with BackwardCompatibleFilterDescriptionTrait and the QueryParameter-based filters (ExactFilter, PartialSearchFilter, EndSearchFilter, ComparisonFilter, OrFilter, …). Removed in 6.0. PHPDoc-only, no trigger_deprecation: the base ctor is still used by the first-party legacy filters, so a runtime trigger would self-fire.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Mark the ORM and ODM Doctrine
AbstractFilterbase classes as@deprecatedsince API Platform 4.4.How
Class-level PHPDoc
@deprecatedon bothsrc/Doctrine/Orm/Filter/AbstractFilter.phpandsrc/Doctrine/Odm/Filter/AbstractFilter.php:Gives third parties extending
AbstractFiltera migration window toward implementingApiPlatform\Metadata\FilterInterfacedirectly (the public BC path documented in #8326) + the canonicalQueryParameterfilters.Why PHPDoc-only (no
trigger_deprecation)AbstractFilteris still extended by the first-party legacy filters (SearchFilter,BooleanFilter,NumericFilter,OrderFilter,DateFilter,RangeFilter,ExistsFilter,BackedEnumFilter). A runtime trigger in the base would self-fire on every internal instantiation and spam users. A PHPDoc tag gives static-analysis / IDE migration signalling without runtime noise. All subclasses keepextends AbstractFilter(no inheritance dropped).BC
Zero BC break — annotation only. Removal target 6.0 (matches the repo's existing 4.4
@deprecatedentries and TODO-filters 6.0 deliverables).Part of the 4.4 filter refactor: ship replacement primaries, then deprecate legacy.