feat(doctrine): doctrine filters like laravel eloquent filters by vinceAmstoutz · Pull Request #6775 · api-platform/core · GitHub
Skip to content

feat(doctrine): doctrine filters like laravel eloquent filters - #6775

Merged
soyuka merged 4 commits into
api-platform:mainfrom
vinceAmstoutz:feat-doctrine-filters-like-laravel-filters
Dec 10, 2024
Merged

feat(doctrine): doctrine filters like laravel eloquent filters #6775
soyuka merged 4 commits into
api-platform:mainfrom
vinceAmstoutz:feat-doctrine-filters-like-laravel-filters

Conversation

@vinceAmstoutz

@vinceAmstoutz vinceAmstoutz commented Nov 5, 2024 •
edited
Loading

Copy link
Copy Markdown
Member
Q A
Branch? main
License MIT
Doc PR Coming soon

Completes #6749.

Goal:

Using Dotrine filters as we use Laravel Eloquent filters. Example using a BooleanFilter with Symfony and Doctrine:

#[ApiResource]
#[GetCollection(
    parameters: [
        'active' => new QueryParameter(
            filter: new BooleanFilter(),
        ),

        // support also for filter aliasing
        'enabled' => new QueryParameter(
            filter: new BooleanFilter(),
            property: 'active',
        ),
    ],
)]
#[ORM\Entity]
class FilteredBooleanParameter {
    // ...
}

TODO:

  • BooleanFilter
  • DateFilter
  • RangeFilter
  • Numeric
  • Exists
  • OrderFilter

Will be done in another PR:

@vinceAmstoutz
vinceAmstoutz force-pushed the feat-doctrine-filters-like-laravel-filters branch from fd22d9c to 93b3226 Compare November 5, 2024 13:07
@vinceAmstoutz vinceAmstoutz changed the title feat(doctrine): doctrine filters like laravel filters feat(doctrine): doctrine filters like laravel eloquent filters Nov 5, 2024
@vinceAmstoutz
vinceAmstoutz force-pushed the feat-doctrine-filters-like-laravel-filters branch from 93b3226 to 6cfee88 Compare November 6, 2024 13:15
@vinceAmstoutz

vinceAmstoutz commented Nov 6, 2024

Copy link
Copy Markdown
Member Author

@soyuka As requested, the swagger UI doc looks like this for the DateFilter:
image

@vinceAmstoutz
vinceAmstoutz force-pushed the feat-doctrine-filters-like-laravel-filters branch 6 times, most recently from 77cb4c6 to fc7f5f1 Compare November 7, 2024 15:08
@vinceAmstoutz

vinceAmstoutz commented Nov 7, 2024

Copy link
Copy Markdown
Member Author

@soyuka As requested, the swagger UI doc looks like this for the RangeFilter:

image

soyuka
soyuka reviewed Nov 8, 2024
View reviewed changes
Comment thread src/Doctrine/Common/Filter/ManagerRegistryAwareInterface.php Outdated
Comment thread src/Doctrine/Odm/Extension/ParameterExtension.php
Comment thread src/Doctrine/Odm/Extension/ParameterExtension.php Outdated
Comment thread src/Doctrine/Odm/Filter/AbstractFilter.php Outdated
Comment thread src/Doctrine/Odm/Filter/BooleanFilter.php Outdated
Comment thread src/Laravel/ApiPlatformProvider.php Outdated
Comment thread src/Metadata/Tests/Resource/Factory/ParameterResourceMetadataCollectionFactoryTests.php Outdated
Comment thread src/Symfony/Bundle/Resources/config/metadata/resource.xml Outdated
Comment thread tests/Functional/Parameters/BooleanFilterTest.php Outdated
Comment thread tests/Functional/Parameters/BooleanFilterTest.php Outdated
@vinceAmstoutz
vinceAmstoutz force-pushed the feat-doctrine-filters-like-laravel-filters branch 3 times, most recently from 2f4ec07 to 8f0620e Compare November 12, 2024 11:01
@vinceAmstoutz
vinceAmstoutz requested a review from soyuka November 12, 2024 11:02
@vinceAmstoutz
vinceAmstoutz force-pushed the feat-doctrine-filters-like-laravel-filters branch 14 times, most recently from 68d2dfb to 3736645 Compare November 13, 2024 13:11
soyuka
soyuka reviewed Nov 14, 2024
View reviewed changes
Comment thread src/Doctrine/Odm/Extension/ParameterExtension.php Outdated
Comment thread src/Doctrine/Odm/Filter/ExistsFilter.php Outdated
Comment thread src/Doctrine/Odm/Filter/ExistsFilter.php
Comment thread tests/Fixtures/TestBundle/Document/FilteredExistsParameter.php
Comment thread tests/Fixtures/TestBundle/Entity/FilteredOrderParameter.php
Comment thread src/Doctrine/Orm/Filter/ExistsFilter.php Outdated
Comment thread src/Doctrine/Odm/Filter/OrderFilter.php
Comment thread src/Doctrine/Orm/Extension/ParameterExtension.php Outdated
Comment thread src/Doctrine/Orm/Filter/ExistsFilter.php
Comment thread src/Doctrine/Orm/Filter/OrderFilter.php Outdated
@vinceAmstoutz
vinceAmstoutz force-pushed the feat-doctrine-filters-like-laravel-filters branch from 74919ff to 4456cb1 Compare November 18, 2024 11:06
@vinceAmstoutz
vinceAmstoutz requested a review from soyuka November 18, 2024 11:07
@vinceAmstoutz
vinceAmstoutz force-pushed the feat-doctrine-filters-like-laravel-filters branch from 4456cb1 to 7513e53 Compare November 18, 2024 13:02
soyuka
soyuka requested changes Nov 22, 2024
View reviewed changes
Comment thread src/Doctrine/Orm/Filter/OrderFilter.php Outdated
Comment thread src/Symfony/Bundle/Resources/config/metadata/resource.xml Outdated
Comment thread src/Doctrine/Orm/Filter/ExistsFilter.php Outdated
Comment thread src/Doctrine/Orm/Filter/DateFilter.php
@vinceAmstoutz
vinceAmstoutz force-pushed the feat-doctrine-filters-like-laravel-filters branch from 7513e53 to eb9277d Compare November 22, 2024 14:13
@vinceAmstoutz vinceAmstoutz mentioned this pull request Dec 5, 2024
Closed
@soyuka
soyuka force-pushed the feat-doctrine-filters-like-laravel-filters branch from eb9277d to db108d5 Compare December 9, 2024 13:04
@soyuka
soyuka force-pushed the feat-doctrine-filters-like-laravel-filters branch from db108d5 to d9bc540 Compare December 9, 2024 13:22
@vinceAmstoutz
vinceAmstoutz force-pushed the feat-doctrine-filters-like-laravel-filters branch from 7047de6 to 3dde14a Compare December 10, 2024 11:01
@vinceAmstoutz
vinceAmstoutz requested a review from soyuka December 10, 2024 11:07
@soyuka
soyuka force-pushed the feat-doctrine-filters-like-laravel-filters branch from e8b6dd9 to d1ffc14 Compare December 10, 2024 12:32
@soyuka
soyuka merged commit f67f6f1 into api-platform:main Dec 10, 2024
@vinceAmstoutz
vinceAmstoutz deleted the feat-doctrine-filters-like-laravel-filters branch December 10, 2024 12:47
@vinceAmstoutz vinceAmstoutz mentioned this pull request Dec 12, 2024
Closed
5 tasks done
@soyuka soyuka mentioned this pull request Dec 13, 2024
Closed
vinceAmstoutz pushed a commit to vinceAmstoutz/api-platform-core that referenced this pull request Dec 24, 2024
Vincent Amstoutz @soyuka
feat(doctrine): doctrine filters like laravel eloquent filters (api-…
6de1a1f 
…platform#6775)

* feat(doctrine): doctrine filters like laravel eloquent filters

* fix: allow multiple validation with :property placeholder

* fix: correct escape filter condition

* fix: remove duplicated block

---------

Co-authored-by: soyuka <soyuka@users.noreply.github.com>
@1ed

1ed commented Dec 28, 2024

Copy link
Copy Markdown

@vinceAmstoutz @soyuka I think, composer.json files should be updated to require the minimum version which contains the new symbols. For example for doctrine-orm and doctrine-odm should be

"api-platform/doctrine-common": "^4.1"

@vinceAmstoutz

vinceAmstoutz commented Dec 28, 2024

Copy link
Copy Markdown
Member Author

@vinceAmstoutz @soyuka I think, composer.json files should be updated to require the minimum version which contains the new symbols. For example for doctrine-orm and doctrine-odm should be

"api-platform/doctrine-common": "^4.1"

Why we should do that? @1ed

@1ed

1ed commented Dec 28, 2024

Copy link
Copy Markdown

@vinceAmstoutz vinceAmstoutz mentioned this pull request Dec 30, 2024
Closed
@GromNaN GromNaN mentioned this pull request Jan 30, 2025
Merged
GromNaN added a commit to GromNaN/api-platform-core that referenced this pull request Jan 30, 2025
@GromNaN
fix(doctrine): fix required version of doctrine-common
b3e75ea 
interface ManagerRegistryAwareInterface implemeted by ApiPlatform\Doctrine\{Orm,Odm}\Filter\AbstractFilter

api-platform#6775
jonerickson pushed a commit to jonerickson/core that referenced this pull request Feb 21, 2025
Vincent Amstoutz @soyuka @jonerickson
feat(doctrine): doctrine filters like laravel eloquent filters (api-p…
509939d 
…latform#6775)

* feat(doctrine): doctrine filters like laravel eloquent filters

* fix: allow multiple validation with :property placeholder

* fix: correct escape filter condition

* fix: remove duplicated block

---------

Co-authored-by: soyuka <soyuka@users.noreply.github.com>
@vinceAmstoutz vinceAmstoutz mentioned this pull request May 5, 2025
Merged
13 tasks done
@VincentLanglet VincentLanglet mentioned this pull request Jan 11, 2026
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@soyuka soyuka Awaiting requested review from soyuka

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@vinceAmstoutz @1ed @soyuka