Enable ClassLocator from Doctrine Persistence 4.1 #2802
Conversation
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
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
GromNaN
changed the title
This was referenced Aug 16, 2025
In the scope of doctrine/persistence#432 (available from `doctrine/persistence` >= 4.1) there was added `ColocatedMappingDriver::$filePaths`, which allows passing an `Traversable` of file paths for the mapping driver to use. This commit integrates those changes into `AttributeDriver` (and `AnnotationDriver`). Since `doctrine/orm` maintains the support for `doctrine/persistence` of older versions, the `AttributeDriver` ensures that `$filePaths` is actually defined. Tests use `InstalledVersions` to opt into new behaviour if `doctrine/persistence` is at least version 4.1. The old behaviour can be adapted into new by using `DirectoryFilesIterator` and `FilePathNameIterator` on directory paths.
GromNaN
force-pushed
the
class-locator
branch
3 times, most recently
from
6388dd8 to
80989af
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR enables ClassLocator support from Doctrine Persistence 4.1, providing more flexible ways to specify document classes for mapping drivers beyond just directory paths. The change allows users to provide class lists or custom locators instead of scanning entire directories.
- Adds support for ClassLocator, ClassNames, and FileClassLocator from Doctrine Persistence 4.1+
- Updates AttributeDriver and AnnotationDriver constructors to accept ClassLocator instances
- Includes backward compatibility checks to work with both old and new versions of Doctrine Persistence
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| lib/Doctrine/ODM/MongoDB/Mapping/Driver/AttributeDriver.php | Adds ClassLocator support and fixes typo in class comment |
| lib/Doctrine/ODM/MongoDB/Mapping/Driver/AnnotationDriver.php | Updates constructor to support ClassLocator and refactors initialization |
| tests/Doctrine/ODM/MongoDB/Tests/BaseTestCase.php | Adds conditional FileClassLocator usage with backward compatibility |
| tests/Doctrine/ODM/MongoDB/Tests/Mapping/*.php | Updates test classes to support new ClassLocator functionality |
| docs/en/reference/metadata-drivers.rst | Documents new ClassLocator usage patterns and examples |
| composer.json | Updates doctrine/persistence dependency to include 4@dev |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
GromNaN
commented
Aug 21, 2025
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.
Summary
Alternative to #2794 using doctrine/persistence#433