[DDC-1247] Implement AnnotationDriver::addExcludePath Created: 04/Jul/11  Updated: 04/Feb/14  Resolved: 04/Feb/14

Status: Resolved
Project: Doctrine 2 - ORM
Component/s: Mapping Drivers
Affects Version/s: Git Master
Fix Version/s: 2.5
Security Level: All

Type: New Feature Priority: Minor
Reporter: Filip Procházka Assignee: Benjamin Eberlei
Resolution: Fixed Votes: 1
Labels: None


 Description   

Hi,
I've been having issues with AnnotationDriver crawling in my directories and loading files.
I have a few classes that require specific libraries loaded, and I don't want the AnnotationDriver to load them.

For example, I have my descendant of PHPUnit_Framework_TestCase in libs and the driver just dies, because PHPUnit is not loaded, and I don't want to load it, to be able to finish the process.

Solution would be add method AnnotationDriver::addExcludePath, whose name speaks for itself

Temporarily, I had to extend the AnnotationDriver and overload the crawling process, which is realy annoing, because I had to copy the whole method with all its exceptions and I would have to maintain it, till this will be in Doctrine. Can be viewed here https://github.com/Kdyby/Framework/blob/master/libs/Kdyby/Doctrine/Mapping/Driver/AnnotationDriver.php

Thanks
Filip



 Comments   
Comment by Jan Dolecek [ 20/Apr/12 ]

This behavior really messes with my projects, as it automatically loads all php files. Not just those with classes, but also simple scripts, which can do horrible stuff (e.g. I've got scripts to make changes in the source code!)

Annotations should be read without executing the scripts, e.g. by TokenReflection library: https://github.com/Andrewsville/PHP-Token-Reflection

Comment by Patrik Votoček [ 27/Aug/12 ]

pull https://github.com/doctrine/common/pull/176

Comment by Christophe Coevoet [ 19/Sep/12 ]

@Jan Tokenizing the file was the way annotations were handled in 2.0. Doctrine 2.1 switched to using Reflection to read annotation because it is faster.

@Filip I'm wondering why you would have PHPUnit testcases in a path storing entities.

Comment by Filip Procházka [ 19/Sep/12 ]

@stof

> Tokenizing the file was the way annotations were handled in 2.0. Doctrine 2.1 switched to using Reflection to read annotation because it is faster.

And it is obviousely the wrong one. There is no argument, that could beat the fact, that the result can and should be cached, as it does already. Correct behaviour is much more valuable than few miliseconds on first run.

> I'm wondering why you would have PHPUnit testcases in a path storing entities.

I don't. They are base classes for the actual tests. I agree they might (or should) be somewhere else, but the fact, that they should not be executed, when readed, stays.

Comment by Christophe Coevoet [ 19/Sep/12 ]

@Filip The AnnotationReader is not loading any file. It simply expects a ReflectionClass.
And for the performances, we are talking about running several times faster here (I don't have the benchmark results anymore but you could search in the merged PRs on Doctrine Common)

The ORM AnnotationDriver expects a path in which it should look for annotated classes, to be able to implement getAllClasses() (as it cannot expect all classes to be already loaded). And btw, the behavior was the same in 2.0 when the reader was using tokenization.

Comment by Doctrine Bot [ 03/Feb/14 ]

A related Github Pull-Request [GH-176] was closed:
https://github.com/doctrine/common/pull/176

Comment by Marco Pivetta [ 04/Feb/14 ]

Merged: https://github.com/doctrine/common/commit/d0c1a60854c69089278e0db13235563748f2fa26

Generated at Fri Oct 24 10:27:58 UTC 2014 using JIRA 6.2.3#6260-sha1:63ef1d6dac3f4f4d7db4c1effd405ba38ccdc558.