Skip to content

fix(metadata): do not override the parameter provider with the filter provider #8689

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
soyuka merged 1 commit into from
Oct 16, 2026
Merged

fix(metadata): do not override the parameter provider with the filter provider #8689

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Metadata/Resource/Factory/ParameterResourceMetadataCollectionFactory.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,7 +377,7 @@ private function addFilterMetadata(Parameter $parameter): Parameter
return $parameter;
}

if ($filter instanceof ParameterProviderFilterInterface) {
if (null === $parameter->getProvider() && $filter instanceof ParameterProviderFilterInterface) {
$parameter = $parameter->withProvider($filter::getParameterProvider());
}

Expand Down
41 changes: 41 additions & 0 deletions src/Metadata/Tests/Resource/Factory/ParameterResourceMetadataCollectionFactoryTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1264,6 +1264,26 @@ public function testSimplePropertyHasNoNestedPropertyInfo(): void
$this->assertArrayNotHasKey('nested_properties_info', $param->getExtraProperties());
}

public function testExplicitProviderIsNotOverriddenByFilterProvider(): void
{
$nameCollection = $this->createStub(PropertyNameCollectionFactoryInterface::class);
$nameCollection->method('create')->willReturn(new PropertyNameCollection(['id']));

$propertyMetadata = $this->createStub(PropertyMetadataFactoryInterface::class);
$propertyMetadata->method('create')->willReturn(new ApiProperty(readable: true));

$parameterFactory = new ParameterResourceMetadataCollectionFactory(
$nameCollection,
$propertyMetadata,
new AttributesResourceMetadataCollectionFactory()
);

$parameters = $parameterFactory->create(HasExplicitParameterProvider::class)->getOperation(forceCollection: true)->getParameters();

$this->assertSame('custom_provider', $parameters->get('explicit')->getProvider());
$this->assertSame('filter_provider', $parameters->get('default')->getProvider());
}

public function testProviderAttachedForClassStringFilterNotRegisteredAsFilterInterface(): void
{
$nameCollection = $this->createStub(PropertyNameCollectionFactoryInterface::class);
Expand Down Expand Up @@ -1303,6 +1323,27 @@ public static function getParameterProvider(): string
}
}

class ParameterProviderFilter implements FilterInterface, ParameterProviderFilterInterface
{
public function getDescription(string $resourceClass): array
{
return [];
}

public static function getParameterProvider(): string
{
return 'filter_provider';
}
}

#[ApiResource]
#[QueryParameter(key: 'explicit', filter: new ParameterProviderFilter(), provider: 'custom_provider')]
#[QueryParameter(key: 'default', filter: new ParameterProviderFilter())]
class HasExplicitParameterProvider
{
public $id;
}

#[ApiResource]
#[QueryParameter(key: 'sparse', filter: ClassStringParameterProviderFilter::class)]
class HasClassStringParameterProviderFilter
Expand Down
Loading