feat(laravel): Eloquent filters search date or #6554

NathanPesneau · 2024-08-29T12:24:46Z

Q	A
Branch?	main
License	MIT

soyuka · 2024-09-05T09:22:39Z

src/Laravel/Eloquent/Extension/FilterQueryExtension.php

@@ -48,7 +48,7 @@ public function apply(Builder $builder, array $uriVariables, Operation $operatio
 continue;
 }

- $filter = $this->filterLocator->has($filterId) ? $this->filterLocator->get($filterId) : null;
+ $filter = $filterId instanceof FilterInterface ? $filterId : ($this->filterLocator->has($filterId) ? $this->filterLocator->get($filterId) : null);
 if ($filter instanceof FilterInterface) {
 $builder = $filter->apply($builder, $values, $parameter, $context);


Suggested change

$builder = $filter->apply($builder, $values, $parameter, $context);

$builder = $filter->apply($builder, $values, $parameter, ($parameter->getFilterContext() ?? []) + $context);

soyuka · 2024-09-05T09:25:16Z

src/Metadata/Resource/Factory/ParameterResourceMetadataCollectionFactory.php

 }

 public function create(string $resourceClass): ResourceMetadataCollection
 {
 $resourceMetadataCollection = $this->decorated?->create($resourceClass) ?? new ResourceMetadataCollection($resourceClass);
-
+ $properties = array_flip(iterator_to_array($this->propertyNameCollectionFactory->create($resourceClass)));


Suggested change

$properties = array_flip(iterator_to_array($this->propertyNameCollectionFactory->create($resourceClass)));

$propertyNameCollection = iterator_to_array($this->propertyNameCollectionFactory->create($resourceClass));

$properties = array_flip($propertyNameCollection);

soyuka · 2024-09-05T09:25:23Z

src/Metadata/Resource/Factory/ParameterResourceMetadataCollectionFactory.php

@@ -61,18 +66,18 @@ public function create(string $resourceClass): ResourceMetadataCollection
 $parameters = $operation->getParameters() ?? new Parameters();
 foreach ($parameters as $key => $parameter) {
 if (':property' === $key) {
- foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $property) {
- $parameter = $this->setDefaults($property, $parameter, $resourceClass);
+ foreach ($properties as $property) {


Suggested change

foreach ($properties as $property) {

foreach ($propertyNameCollection as $property) {

soyuka · 2024-09-05T09:26:08Z

src/Metadata/Resource/Factory/ParameterResourceMetadataCollectionFactory.php

@@ -61,18 +66,18 @@ public function create(string $resourceClass): ResourceMetadataCollection
 $parameters = $operation->getParameters() ?? new Parameters();
 foreach ($parameters as $key => $parameter) {
 if (':property' === $key) {
- foreach ($this->propertyNameCollectionFactory->create($resourceClass) as $property) {
- $parameter = $this->setDefaults($property, $parameter, $resourceClass);
+ foreach ($properties as $property) {


dump maybe $property to check its value

soyuka · 2024-09-05T09:30:47Z

src/Laravel/workbench/app/Models/Author.php

 class Author extends Model
 {
 use HasFactory;
- use IsApiResource;
+ // use IsApiResource;


public function apiResource(): ApiResource { return new ApiResource(parameters: [new QueryParameter(key: ':property', filter: PartialSearchFilter::class)]); }

#[QueryParameter(key: ':property', filter: SearchFilter::class)] use IsApiResource

soyuka · 2024-09-05T09:32:06Z

src/Laravel/ServiceLocator.php

@@ -13,6 +13,7 @@

 namespace ApiPlatform\Laravel;

+use ApiPlatform\Laravel\Eloquent\Filter\FilterInterface;


Suggested change

use ApiPlatform\Laravel\Eloquent\Filter\FilterInterface;

soyuka · 2024-09-05T09:33:06Z

src/Laravel/Eloquent/Filter/AfterDateFilter.php

+ return $builder;
+ }
+
+ // TODO: orderByRaw -> add protection against SQL injection


Suggested change

// TODO: orderByRaw -> add protection against SQL injection

soyuka · 2024-09-05T09:38:31Z

src/Laravel/Eloquent/Filter/AfterDateFilter.php

+ return $builder->whereDate($parameter->getProperty(), '>=', $datetime)
+ ->orWhereNull($parameter->getProperty())
+ ->orderByRaw("{$parameter->getProperty()} ASC NULLS LAST");
+ }


Use only 2 strategies: 'include_null', 'exclude_null' (defaults to exclude_null)

->where(function (Builder $query) { $query->orWhere() ->orWhereNull(); })

SELECT * WHERE .... AND (date >= NOW() OR date IS NULL)
SELECT * WHERE .... AND (date >= NOW() AND date IS NOT NULL)

soyuka · 2024-09-05T09:46:16Z

src/Laravel/workbench/app/Models/Book.php

+ filterContext: ['nulls_comparison' => 'include_null_before_and_after']
+)]
+#[QueryParameter(key: 'isbn_range', schema: ['type' => 'string'], filter: RangeFilter::class, property: 'isbn', description: 'Syntax: \<lt\>.\<valueToCompareTo\> You can use lt, gt, lte, gte or between (to do it, add: .\<value\> at the end)')]
+#[QueryParameter(key: 'order', schema: ['type' => 'string'], filter: OrderFilter::class, description: 'Syntax: \<propertyToOrderOn\>.\<asc|desc\>', filterContext: ['nulls_comparison' => 'nulls_smallest'])]


A garder:

#[QueryParameter(key: 'order[:property]', schema: ['type' => 'string'], filter: OrderFilter::class, description: 'Syntax: \<propertyToOrderOn\>.\<asc|desc\>'])] order[name]=asc|desc

#[QueryParameter(key: 'order[name]', schema: ['type' => 'string'], filter: OrderFilter::class)] order[name]=asc|desc

#[QueryParameter(key: 'name', schema: ['type' => 'string'], filter: OrderFilter::class, description: 'Syntax: \<propertyToOrderOn\>.\<asc|desc\>'])] name=asc

soyuka · 2024-09-05T09:48:10Z

src/Laravel/workbench/app/Models/Book.php

+ property: 'publication_date',
+ filterContext: ['nulls_comparison' => 'include_null_before_and_after']
+)]
+#[QueryParameter(key: 'isbn_range', schema: ['type' => 'string'], filter: RangeFilter::class, property: 'isbn', description: 'Syntax: \<lt\>.\<valueToCompareTo\> You can use lt, gt, lte, gte or between (to do it, add: .\<value\> at the end)')]


isbn_range[lt]=2

soyuka reviewed Sep 5, 2024

View reviewed changes

NathanPesneau force-pushed the feat/laravel/filters branch 2 times, most recently from 03189ac to 11e5b66 Compare September 6, 2024 07:47

Nathan added 3 commits September 6, 2024 09:54

feat(laravel): Eloquent filters search date or

44247ea

feat(laravel): eloquent filters order range equals afterdate

0cb8680

fix(laravel): order afterDate filters

94691b2

NathanPesneau force-pushed the feat/laravel/filters branch from 11e5b66 to 94691b2 Compare September 6, 2024 07:56

soyuka mentioned this pull request Sep 6, 2024

feat(laravel): eloquent filters (search, date, equals, or) #6593

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(laravel): Eloquent filters search date or #6554

feat(laravel): Eloquent filters search date or #6554

NathanPesneau commented Aug 29, 2024

soyuka Sep 5, 2024

soyuka Sep 5, 2024

soyuka Sep 5, 2024

soyuka Sep 5, 2024

soyuka Sep 5, 2024 •

edited

Loading

soyuka Sep 5, 2024

soyuka Sep 5, 2024

soyuka Sep 5, 2024

soyuka Sep 5, 2024 •

edited

Loading

soyuka Sep 5, 2024 •

edited

Loading

soyuka Sep 5, 2024

	$builder = $filter->apply($builder, $values, $parameter, $context);
	$builder = $filter->apply($builder, $values, $parameter, ($parameter->getFilterContext() ?? []) + $context);

	$properties = array_flip(iterator_to_array($this->propertyNameCollectionFactory->create($resourceClass)));
	$propertyNameCollection = iterator_to_array($this->propertyNameCollectionFactory->create($resourceClass));
	$properties = array_flip($propertyNameCollection);

	foreach ($properties as $property) {
	foreach ($propertyNameCollection as $property) {

		@@ -13,6 +13,7 @@

		namespace ApiPlatform\Laravel;

		use ApiPlatform\Laravel\Eloquent\Filter\FilterInterface;

feat(laravel): Eloquent filters search date or #6554

Are you sure you want to change the base?

feat(laravel): Eloquent filters search date or #6554

Conversation

NathanPesneau commented Aug 29, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soyuka Sep 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soyuka Sep 5, 2024 • edited Loading

Choose a reason for hiding this comment

soyuka Sep 5, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

soyuka Sep 5, 2024 •

edited

Loading

soyuka Sep 5, 2024 •

edited

Loading

soyuka Sep 5, 2024 •

edited

Loading