Drop misleading @internal annotation on TextFilterType#7592
Merged
javiereguiluz merged 1 commit intoEasyCorp:5.xfrom May 4, 2026
Merged
Drop misleading @internal annotation on TextFilterType#7592javiereguiluz merged 1 commit intoEasyCorp:5.xfrom
javiereguiluz merged 1 commit intoEasyCorp:5.xfrom
Conversation
The annotation said 'Don't use this to define a text filter. Use Filter\TextFilter instead.', but custom filters that need to reuse TextFilterType's form (e.g. an OR-flavored text filter) MUST pass TextFilterType::class to setFormType() — it's exactly what Filter\TextFilter::new() does internally. The @internal annotation made phpstan flag every legitimate external reference and steered users toward the wrong class (Filter\TextFilter, which is not a FormType and crashes the form registry). Aligns TextFilterType with the 8 sibling FilterType classes (ArrayFilterType, BooleanFilterType, etc.) which carry no such annotation. No behavior change. Closes EasyCorp#7393
Collaborator
|
Thanks Louis-Arnaud. |
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
2 participants
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.
TextFilterTypecarried@internal Don't use this to define a text filter. Use Filter\\TextFilter instead., butFilter\\TextFilter::new()itself does->setFormType(TextFilterType::class): any custom filter that wants to reuse the text-filter form (e.g. an OR-flavored text filter) must referenceTextFilterType. The annotation made phpstan flag every legitimate external reference and steered users towardFilter\\TextFilterinstead, which is not aFormTypeInterfaceand crashes the form registry.Removing the annotation aligns
TextFilterTypewith the 8 sibling*FilterTypeclasses (ArrayFilterType,BooleanFilterType,ChoiceFilterType,ComparisonFilterType,DateTimeFilterType,EntityFilterType,NullFilterType,NumericFilterType) which carry no such annotation. No behavior change.Closes #7393