feat(doctrine): search filters like laravel eloquent filters #6865
Conversation
This file contains 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
6 tasks
fc01fcd to
093aede
Compare
7bfc697 to
a9d3bd6
Compare
soyuka
reviewed
Dec 20, 2024
|
|
||
| $queryBuilder | ||
| ->andWhere(\sprintf('%s.%s = :%s', $alias, $property, $parameterName)) | ||
| ->setParameter($parameterName, $resource->getId()); |
There was a problem hiding this comment.
Properties should be available inside the $context['parameter']:
If the parameter has :property you should get an array of properties inside Parameter::extraProperties if not use Parameter::property and in the end the Parameter::key.
The only thing we need to do here is to check if our doctrine entity has that property/association (re-use some of the code that we already have for that).
e3b56c8 to
55cb458
Compare
55cb458 to
06f47dd
Compare
aegypius
reviewed
Jan 10, 2025
|
|
||
| public function getOpenApiParameters(Parameter $parameter): OpenApiParameter|array|null | ||
| { | ||
| return new OpenApiParameter(name: $parameter->getKey().'[]', in: 'query', style: 'deepObject', explode: true); |
There was a problem hiding this comment.
I don't think we should hardcode parameter value style in the filter, I would rather be able to define the default strategy to use in the configuration and fallback to the default
Suggested change
| return new OpenApiParameter(name: $parameter->getKey().'[]', in: 'query', style: 'deepObject', explode: true); | |
| return new OpenApiParameter(name: $parameter->getKey(), in: 'query'); |
should be suffisant for most of the cases.
Any thoughts @soyuka ?
There was a problem hiding this comment.
If you define your own OpenApiParameter this will not get called AFAIK
vinceAmstoutz
commented
Jan 13, 2025
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
| public function getType(string $doctrineType): string |
There was a problem hiding this comment.
TO DO: remove
vinceAmstoutz
commented
Jan 13, 2025
Comment on lines
+39
to
+45
| if ( | ||
| null === $value | ||
| || !$this->isPropertyEnabled($property, $resourceClass) | ||
| || !$this->isPropertyMapped($property, $resourceClass, true) | ||
| ) { | ||
| return; | ||
| } |
There was a problem hiding this comment.
TODO: try to remove
vinceAmstoutz
commented
Jan 13, 2025
Comment on lines
+32
to
+76
| foreach ($context['filters'] as $property => $value) { | ||
| $this->filterProperty($this->denormalizePropertyName($property), $value, $queryBuilder, $queryNameGenerator, $resourceClass, $operation, $context); | ||
| } | ||
| } | ||
|
|
||
| public function getDescription(string $resourceClass): array | ||
| { | ||
| throw new RuntimeException('Not implemented.'); | ||
| } | ||
|
|
||
| /** | ||
| * Determines whether the given property is enabled. | ||
| */ | ||
| protected function isPropertyEnabled(string $property, string $resourceClass): bool | ||
| { | ||
| if (null === $this->properties) { | ||
| // to ensure sanity, nested properties must still be explicitly enabled | ||
| return !$this->isPropertyNested($property, $resourceClass); | ||
| } | ||
|
|
||
| return \array_key_exists($property, $this->properties); | ||
| } | ||
|
|
||
| protected function denormalizePropertyName(string|int $property): string | ||
| { | ||
| if (!$this->nameConverter instanceof NameConverterInterface) { | ||
| return (string) $property; | ||
| } | ||
|
|
||
| return implode('.', array_map($this->nameConverter->denormalize(...), explode('.', (string) $property))); | ||
| } | ||
|
|
||
| public function hasManagerRegistry(): bool | ||
| { | ||
| return $this->managerRegistry instanceof ManagerRegistry; | ||
| } | ||
|
|
||
| public function getManagerRegistry(): ManagerRegistry | ||
| { | ||
| return $this->managerRegistry; | ||
| } | ||
|
|
||
| public function setManagerRegistry(ManagerRegistry $managerRegistry): void | ||
| { | ||
| $this->managerRegistry = $managerRegistry; |
There was a problem hiding this comment.
TODO: try to remove
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
mainCompletes #6775.
TODO:
Filters support
Extra work