Skip to content

Introduce ClassLocator to find class names for attribute drivers #433

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

Jump to bottom
Merged
merged 12 commits into from
Aug 15, 2025
Merged

Introduce ClassLocator to find class names for attribute drivers #433

merged 12 commits into from
Aug 15, 2025

Conversation

GromNaN
Copy link
Member

@GromNaN GromNaN commented Aug 12, 2025 •
edited
Loading

Alternative approach to #432 to decouple the class name discovery from the read of metadata in the attribute (and annotation) drivers.

Other drivers use a FileLocator to provide the list of files to read.

For the attribute/annotation/static-php drivers, the driver class itself does the directory scanning, while its main purpose is to load the metadata of each class.

In this PR I introduce a ClassLocator interface with 2 implementations:

  • ClassNames is a simple list of classes names
  • FileClassLocator scans a list of files, it can also be constructed from a list of directories to support the current usage. FileClassLocator::createFromDirectories($dirPaths, $fileExtension, $excludedDirs).

My goal is to make it possible in Symfony to tag any class in the project with the #[Entity] attribute and get it identified by the EntityManager. Symfony DI resource discovery feature will be leveraged so that we don't need to scan the directories in Doctrine (which is done at runtime, and may be cached).

rela589n added 4 commits August 8, 2025 14:35
@rela589n
Optimize: use O(1) item lookup instead of O(M)
a6b38ce 
 When checking $includedFiles for an included file,
 the previous `in_array()` approach, executed in a loop,
 is very expensive. Basically, it results in performance
 of O(N * M), where N - number of declared classes,
 M - number of included classes. The current approach
 is O(N), since `isset()` check has constant `O(1)` time.
@rela589n
Refactor: extract FilePathNameIterator
8b501b9 
This change makes it easy for the depending libraries to use iterable of
`SplFileInfo`, adapted to the format of `ColocatedMappingDriver` file paths.
For example, one could provide an instance of Symfony Finder, adapted with
`FilePathNameIterator` without having to reinvent it from scratch.
@rela589n
Refactor: extract DirectoryFilesIterator
df06aca 
This change makes it easy for the client code to migrate toward the
newer version. The migration would be as easy as passing
`new FilePathIterator(new DirectoryFilesIterator($paths))` into
the constructor instead of the array of `$paths`.
@rela589n
Feature: accept iterable of file paths
a241c82 
This commit adds support for `ColocatedMappingDriver` to accept
`iterable` of file paths. Before it was only possible to accept
an array of directory paths. Now, one could provide fine-grained
iterator of only necessary files to the Driver. Bundles should
use Symfony Finder to implement it, since it gives much flexibility
to the client code to configure which files should be included
and which not.

Backward compatibility is achieved with the following approach:
If it's an array, then it should be OK to take a look at `$paths[0]`
and determine if it is a file or a directory. If it's not an array,
we can assume that it's `$filePaths` iterable that's given.
@GromNaN
Copy link
Member Author

GromNaN commented Aug 12, 2025

@rela589n This PR goes a step further than what you've proposed, by exposing a list of class names instead of scanning file.

greg0ire
greg0ire reviewed Aug 12, 2025
View reviewed changes
greg0ire
greg0ire reviewed Aug 12, 2025
View reviewed changes
@GromNaN GromNaN changed the title Introduce ClassLocator to find classes names for attribute drivers Introduce ClassLocator to find class names for attribute drivers Aug 12, 2025
@GromNaN GromNaN force-pushed the class-locator branch 5 times, most recently from 8e475b1 to 1ee8060 Compare August 12, 2025 22:02
greg0ire
greg0ire previously approved these changes Aug 13, 2025
View reviewed changes
rela589n
rela589n reviewed Aug 13, 2025
View reviewed changes
@GromNaN GromNaN mentioned this pull request Aug 13, 2025
Merged
@GromNaN GromNaN deleted the class-locator branch August 15, 2025 08:58
rela589n added a commit to rela589n/doctrine-phpcr-odm that referenced this pull request Aug 16, 2025
@rela589n
Feature: add support for ClassLocator from doctrine/persistence 4.1
49caecb 
The changes integrate doctrine/persistence#433
ClassLocator allows clients to pass any iterable of classes they might want.
@rela589n rela589n mentioned this pull request Aug 16, 2025
Open
rela589n added a commit to rela589n/doctrine-orm that referenced this pull request Aug 16, 2025
@rela589n
Feature: add support for ClassLocator
a4d3bcb 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator` property, which allows
passing any instance of `ClassLocator` for the mapping driver to use.
This commit integrates those changes into `AttributeDriver`.

Since `doctrine/orm` maintains the support for `doctrine/persistence`
of older versions, tests ensure that `ClassLocator` actually exists.

The old paths behaviour can be adapted into the new by using
`FileClassLocator::createFromDirectories($directoryPaths)` and
passing it as a class locator to `AttributeDriver`.

# Conflicts:
#	tests/Tests/ORM/Persisters/BinaryIdPersisterTest.php
rela589n added a commit to rela589n/doctrine-orm that referenced this pull request Aug 16, 2025
@rela589n
Feature: add support for ClassLocator
08bc98f 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator` (`ClassLocator`) property,
which allows passing any instance of `ClassLocator` for the mapping
driver to use. This commit integrates those changes into `AttributeDriver`.

Since `doctrine/orm` maintains the support for `doctrine/persistence`
of older versions, tests ensure that `ClassLocator` actually exists.

The old paths' behaviour can be adapted into the new by passing
`FileClassLocator` into `AttributeDriver`
(see `FileClassLocator::createFromDirectories($directoryPaths)`).
@rela589n rela589n mentioned this pull request Aug 16, 2025
Merged
rela589n added a commit to rela589n/doctrine-orm that referenced this pull request Aug 16, 2025
@rela589n
Feature: add support for ClassLocator
db32d72 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator` (`ClassLocator`) property,
which allows passing any instance of `ClassLocator` for the mapping
driver to use. This commit integrates those changes into `AttributeDriver`.

Since `doctrine/orm` maintains the support for `doctrine/persistence`
of older versions, tests ensure that `ClassLocator` actually exists.

The old paths' behaviour can be adapted into the new by passing
`FileClassLocator` into `AttributeDriver`
(see `FileClassLocator::createFromDirectories($directoryPaths)`).
rela589n added a commit to rela589n/doctrine-phpcr-odm that referenced this pull request Aug 16, 2025
@rela589n
Feature: add support for ClassLocator from doctrine/persistence 4.1
f1befde 
The changes integrate doctrine/persistence#433
ClassLocator allows clients to pass any iterable of classes they might want.
@GromNaN GromNaN mentioned this pull request Aug 18, 2025
Closed
rela589n added a commit to rela589n/doctrine-orm that referenced this pull request Aug 20, 2025
@rela589n
Feature: add support for ClassLocator
87571e2 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator` (`ClassLocator`) property,
which allows passing any instance of `ClassLocator` for the mapping
driver to use. This commit integrates those changes into `AttributeDriver`.

Since `doctrine/orm` maintains the support for `doctrine/persistence`
of older versions, tests ensure that `ClassLocator` actually exists.

The old paths' behaviour can be adapted into the new by passing
`FileClassLocator` into `AttributeDriver`
(see `FileClassLocator::createFromDirectories($directoryPaths)`).
rela589n added a commit to rela589n/doctrine-orm that referenced this pull request Aug 20, 2025
@rela589n
Feature: add support for ClassLocator
d6d4848 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator` (`ClassLocator`) property,
which allows passing any instance of `ClassLocator` for the mapping
driver to use. This commit integrates those changes into `AttributeDriver`.

Since `doctrine/orm` maintains the support for `doctrine/persistence`
of older versions, tests ensure that `ClassLocator` actually exists.

The old paths' behaviour can be adapted into the new by passing
`FileClassLocator` into `AttributeDriver`
(see `FileClassLocator::createFromDirectories($directoryPaths)`).
rela589n added a commit to rela589n/doctrine-phpcr-odm that referenced this pull request Aug 21, 2025
@rela589n
Feature: add support for ClassLocator from doctrine/persistence 4.1
82a125b 
The changes integrate doctrine/persistence#433
ClassLocator allows clients to pass any iterable of classes they might want.
rela589n added a commit to rela589n/doctrine-phpcr-odm that referenced this pull request Aug 21, 2025
@rela589n
Feature: add support for ClassLocator from doctrine/persistence 4.1
6ea264a 
The changes integrate doctrine/persistence#433
ClassLocator allows clients to pass any iterable of classes they might want.
rela589n added a commit to rela589n/doctrine-orm that referenced this pull request Aug 21, 2025
@rela589n
Feature: add support for ClassLocator
78d0c0f 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator` (`ClassLocator`) property,
which allows passing any instance of `ClassLocator` for the mapping
driver to use. This commit integrates those changes into `AttributeDriver`.

Since `doctrine/orm` maintains the support for `doctrine/persistence`
of older versions, tests ensure that `ClassLocator` actually exists.

The old paths' behaviour can be adapted into the new by passing
`FileClassLocator` into `AttributeDriver`
(see `FileClassLocator::createFromDirectories($directoryPaths)`).
rela589n added a commit to rela589n/doctrine-phpcr-odm that referenced this pull request Aug 21, 2025
@rela589n
Feature: add support for ClassLocator from doctrine/persistence 4.1
643d4df 
These changes integrate doctrine/persistence#433
`ClassLocator` allows clients to pass any iterable of classes they might want.
rela589n added a commit to rela589n/doctrine-phpcr-odm that referenced this pull request Aug 21, 2025
@rela589n
Feature: add support for ClassLocator from doctrine/persistence 4.1
dc1b028 
These changes integrate doctrine/persistence#433
`ClassLocator` allows clients to pass any iterable of classes they might want.
rela589n added a commit to rela589n/doctrine-orm that referenced this pull request Aug 21, 2025
@rela589n
Feature: add support for ClassLocator
87b20ac 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator` (`ClassLocator`) property,
which allows passing any instance of `ClassLocator` for the mapping
driver to use. This commit integrates those changes into `AttributeDriver`.

Since `doctrine/orm` maintains the support for `doctrine/persistence`
of older versions, tests ensure that `ClassLocator` actually exists.

The old paths' behaviour can be adapted into the new by passing
`FileClassLocator` into `AttributeDriver`
(see `FileClassLocator::createFromDirectories($directoryPaths)`).
rela589n added a commit to rela589n/doctrine-orm that referenced this pull request Aug 21, 2025
@rela589n
Feature: add support for ClassLocator
b2290c5 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator` (`ClassLocator`) property,
which allows passing any instance of `ClassLocator` for the mapping
driver to use. This commit integrates those changes into `AttributeDriver`.

Since `doctrine/orm` maintains the support for `doctrine/persistence`
of older versions, tests ensure that `ClassLocator` actually exists.

The old paths' behaviour can be adapted into the new by passing
`FileClassLocator` into `AttributeDriver`
(see `FileClassLocator::createFromDirectories($directoryPaths)`).
@github-actions github-actions bot mentioned this pull request Aug 22, 2025
Merged
rela589n added a commit to rela589n/doctrine-orm that referenced this pull request Aug 23, 2025
@rela589n
Feature: add support for ClassLocator
ed9ba16 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator` (`ClassLocator`) property,
which allows passing any instance of `ClassLocator` for the mapping
driver to use. This commit integrates those changes into `AttributeDriver`.

Since `doctrine/orm` maintains the support for `doctrine/persistence`
of older versions, tests ensure that `ClassLocator` actually exists.

The old paths' behaviour can be adapted into the new by passing
`FileClassLocator` into `AttributeDriver`
(see `FileClassLocator::createFromDirectories($directoryPaths)`).
rela589n added a commit to rela589n/symfony that referenced this pull request Aug 27, 2025
@rela589n
feature: add support for ClassLocator
4c35114 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator`, which allows passing any
instance of `ClassLocator` for the mapping driver to use.

This commit integrates those changes into `AbstractDoctrineExtension`,
used by respective ORM, MongoDB-ODM, PHPCR-ODM bundles. The solution
registers a "mapping_class_finder" service that can be used by the
client code to customize class finding logic.

The changes come into play starting with doctrine/persistence >= 4.1,
and the actual registration happens only if `AttributeDriver` supports
`ClassLocator`.

Dependent libraries would adhere to the same interface, where
`ClassLocator` is in the first argument.

The changes were introduced for:
- ORM: doctrine/orm#12131;
- ODM: doctrine/mongodb-odm#2802;
- PHPCR ODM: doctrine/phpcr-odm#875.
rela589n added a commit to rela589n/symfony that referenced this pull request Aug 27, 2025
@rela589n
feature: add support for ClassLocator
26d6ea5 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator`, which allows passing any
instance of `ClassLocator` for the mapping driver to use.

This commit integrates those changes into `AbstractDoctrineExtension`,
used by respective ORM, MongoDB-ODM, PHPCR-ODM bundles. The solution
registers a "mapping_class_finder" service that can be used by the
client code to customize class finding logic.

The changes come into play starting with doctrine/persistence >= 4.1,
and the actual registration happens only if `AttributeDriver` supports
`ClassLocator`.

Dependent libraries would adhere to the same interface, where
`ClassLocator` is in the first argument.

The changes were introduced for:
- ORM: doctrine/orm#12131;
- ODM: doctrine/mongodb-odm#2802;
- PHPCR ODM: doctrine/phpcr-odm#875.
@GromNaN GromNaN mentioned this pull request Aug 27, 2025
Open
rela589n added a commit to rela589n/symfony that referenced this pull request Aug 27, 2025
@rela589n
feature: add support for ClassLocator
70f5b6a 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator`, which allows passing any
instance of `ClassLocator` for the mapping driver to use.

This commit integrates those changes into `AbstractDoctrineExtension`,
used by respective ORM, MongoDB-ODM, PHPCR-ODM bundles. The solution
registers a "mapping_class_finder" service that can be used by the
client code to customize class finding logic.

The changes come into play starting with doctrine/persistence >= 4.1,
and the actual registration happens only if `AttributeDriver` supports
`ClassLocator`.

Dependent libraries would adhere to the same interface, where
`ClassLocator` is in the first argument.

The changes were introduced for:
- ORM: doctrine/orm#12131;
- ODM: doctrine/mongodb-odm#2802;
- PHPCR ODM: doctrine/phpcr-odm#875.
rela589n added a commit to rela589n/symfony that referenced this pull request Aug 27, 2025
@rela589n
feature: add support for ClassLocator
fac4257 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator`, which allows passing any
instance of `ClassLocator` for the mapping driver to use.

This commit integrates those changes into `AbstractDoctrineExtension`,
used by respective ORM, MongoDB-ODM, PHPCR-ODM bundles. The solution
registers a "mapping_class_finder" service that can be used by the
client code to customize class finding logic.

The changes come into play starting with doctrine/persistence >= 4.1,
and the actual registration happens only if `AttributeDriver` supports
`ClassLocator`.

Dependent libraries would adhere to the same interface, where
`ClassLocator` is in the first argument.

The changes were introduced for:
- ORM: doctrine/orm#12131;
- ODM: doctrine/mongodb-odm#2802;
- PHPCR ODM: doctrine/phpcr-odm#875.
@rela589n rela589n mentioned this pull request Aug 27, 2025
Open
rela589n added a commit to rela589n/symfony that referenced this pull request Aug 27, 2025
@rela589n
[DoctrineBridge] feature: add support for ClassLocator
1b5a0c6 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator`, which allows passing any
instance of `ClassLocator` for the mapping driver to use.

This commit integrates those changes into `AbstractDoctrineExtension`,
used by respective ORM, MongoDB-ODM, PHPCR-ODM bundles. The solution
registers a "mapping_class_finder" service that can be used by the
client code to customize class finding logic.

The changes come into play starting with doctrine/persistence >= 4.1,
and the actual registration happens only if `AttributeDriver` supports
`ClassLocator`.

Dependent libraries would adhere to the same interface, where
`ClassLocator` is in the first argument.

The changes were introduced for:
- ORM: doctrine/orm#12131;
- ODM: doctrine/mongodb-odm#2802;
- PHPCR ODM: doctrine/phpcr-odm#875.
rela589n added a commit to rela589n/symfony that referenced this pull request Aug 27, 2025
@rela589n
[DoctrineBridge] feature: add support for ClassLocator
ad2b74b 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator`, which allows passing any
instance of `ClassLocator` for the mapping driver to use.

This commit integrates those changes into `AbstractDoctrineExtension`,
used by respective ORM, MongoDB-ODM, PHPCR-ODM bundles. The solution
registers a "mapping_class_finder" service that can be used by the
client code to customize class finding logic.

The changes come into play starting with doctrine/persistence >= 4.1,
and the actual registration happens only if `AttributeDriver` supports
`ClassLocator`.

Dependent libraries would adhere to the same interface, where
`ClassLocator` is in the first argument.

The changes were introduced for:
- ORM: doctrine/orm#12131;
- ODM: doctrine/mongodb-odm#2802;
- PHPCR ODM: doctrine/phpcr-odm#875.
rela589n added a commit to rela589n/symfony that referenced this pull request Aug 29, 2025
@rela589n
[DoctrineBridge] feature: add support for ClassLocator
13a8910 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator`, which allows passing any
instance of `ClassLocator` for the mapping driver to use.

This commit integrates those changes into `AbstractDoctrineExtension`,
used by respective ORM, MongoDB-ODM, PHPCR-ODM bundles. The solution
registers a "mapping_class_finder" service that can be used by the
client code to customize class finding logic.

The changes come into play starting with doctrine/persistence >= 4.1,
and the actual registration happens only if `AttributeDriver` supports
`ClassLocator`.

Dependent libraries would adhere to the same interface, where
`ClassLocator` is in the first argument.

The changes were introduced for:
- ORM: doctrine/orm#12131;
- ODM: doctrine/mongodb-odm#2802;
- PHPCR ODM: doctrine/phpcr-odm#875.
rela589n added a commit to rela589n/symfony that referenced this pull request Aug 29, 2025
@rela589n
[DoctrineBridge] feature: add support for ClassLocator
9c126d4 
In the scope of doctrine/persistence#433
(available from `doctrine/persistence` >= 4.1) there was added
`ColocatedMappingDriver::$classLocator`, which allows passing any
instance of `ClassLocator` for the mapping driver to use.

This commit integrates those changes into `AbstractDoctrineExtension`,
used by respective ORM, MongoDB-ODM, PHPCR-ODM bundles. The solution
registers a "mapping_class_finder" service that can be used by the
client code to customize class finding logic.

The changes come into play starting with doctrine/persistence >= 4.1,
and the actual registration happens only if `AttributeDriver` supports
`ClassLocator`.

Dependent libraries would adhere to the same interface, where
`ClassLocator` is in the first argument.

The changes were introduced for:
- ORM: doctrine/orm#12131;
- ODM: doctrine/mongodb-odm#2802;
- PHPCR ODM: doctrine/phpcr-odm#875.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@greg0ire greg0ire greg0ire approved these changes

@SenseException SenseException SenseException approved these changes

@beberlei beberlei Awaiting requested review from beberlei

@alcaeus alcaeus Awaiting requested review from alcaeus

@stof stof Awaiting requested review from stof

@derrabus derrabus Awaiting requested review from derrabus

@IonBazan IonBazan Awaiting requested review from IonBazan

@malarzm malarzm Awaiting requested review from malarzm

@paulinevos paulinevos Awaiting requested review from paulinevos

+1 more reviewer

@rela589n rela589n rela589n approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees
No one assigned
Labels
Enhancement New feature or request
Projects
None yet
Milestone
4.1.0
Development

Successfully merging this pull request may close these issues.
4 participants
@GromNaN @greg0ire @SenseException @rela589n