PSR-0 annotation reader, try #2 #154

chx · 2012-06-18T05:18:22Z

This is a radically different approach to the same goal: use less memory. See #152 for some discussion but most of it is irrelevant to this code that's why I opened a new pull request.

Note how most files are new and only Psr0Parser needed to change and even that only in very small ways.

Usage:

$parser = new Psr0Parser('path/to/your/lib', 'Drupal\\block\\Plugins\\owner\\type\\test');
$reader = new AnnotationReader();
var_dump($reader->getPropertyAnnotations($parser->getPropertyReflection('foo')));

If we decide that this is an approach worth pursuing, adding tests will be very easy because Doctrine is PSR-0 itself.

… other two needs more exception throwing.

chx · 2012-06-18T05:20:06Z

lib/Doctrine/Common/Annotations/Psr0ClassReflection.php

+  public function getUseStatements() {
+    return $this->psr0Parser->getUseStatements();
+  }
+  static function export($argument, $return = FALSE) { throw new ReflectionException('Method not implemented'); }


Yes this is ugly but otherwise PHP fatals. And, some of these could actually be implemented if we wanted to. I didn't :) How much we want this to be generally useable? I voted on the minimal viable approach even if the implementation would be an empty function body like for getExtension.

stof · 2012-06-18T07:23:30Z

Please follow the Doctrine coding standards (which are more or less PSR-2) for the code you contribute

chx · 2012-06-18T07:37:54Z

Sorry. I am old fashioned and still use two spaces. (I wonder however how we managed to end up with four when it's completely unreadable. Oh well.)

The bigger question is, are we happy with this direction? I will add tests, fix coding style, whatnot if we are. I already abandoned one branch so no point in wasting time with that if this won't be merged.

akkie · 2012-06-18T07:49:17Z

lib/Doctrine/Common/Annotations/Psr0Parser.php

+                        $token = $this->next();
+                        $this->parentClassName = $token[1];
+                        if ($this->parentClassName[0] !== '\\') {
+                          $this->parentClassName = $this->ns . '\\' . $this->parentClass;


This doesn't work. You can also write:

<?php namespace Doctrine\Common\Annotations; use Doctrine\Common as CommonNS; class Parser extends CommonNS\ParentClass {}

To resolve class names you need all use statements first and then you must resolve the FQN with the help of PHPs name resolution rules.
http://de.php.net/manual/en/language.namespaces.rules.php

Thanks, that's very useful! Good that we have the use statements parsed already.

but it is still not fixed

stof · 2012-06-18T17:28:55Z

lib/Doctrine/Common/Annotations/Psr0Parser.php

+    public function __construct($includePath, $className, $classAnnotationOptimize = FALSE)
+    {
+        $this->className = ltrim($className, '\\');
+        $this->fileName  = $includePath . DIRECTORY_SEPARATOR . str_replace('\\', DIRECTORY_SEPARATOR, $className) . '.php';


this would mean that all your libraries have to live in the same folder, which is absolutely not a requirement in PSR-0, and will be wrong as soon as you use some vendor libraries in your code (as you will not mix the repositories together)

I do not get this. You can pass 'vendor/Symfony' or 'vendor/Doctrine' or whatever else. That's why $includePath is an argument.

stof · 2012-06-18T17:38:13Z

I see an issue: the original PhpParser is a service object: you create one instance and you use it everywhere you need it. And for instance, the AnnotationReader create one PhpParser and uses it for all classes. Your Psr0Parser on the other hand is not such a service object: you can use it only once and have to create a new one for each class.

stof · 2012-06-18T17:43:37Z

and btw, it will not be usable as a drop-in replacement of the PhpParser: if you inject create a Psr0Parser, the code using the parser would still call the logic of the parent parser.
So your Psr0Parser cannot be used to read the annotations with the Doctrine annotation reader

chx · 2012-06-18T17:48:01Z

Sorry I do not understand why this can not be used with the Doctrine annotation reader. Please see the original post on a usage example -- it's working already or at least it seemed to me.

stof · 2012-06-18T17:52:24Z

Well, you use your parser as a service responsible to instantiate the reflection, not as a parser in the reader. So it is really weird to extend from the parser.

chx · 2012-06-18T17:53:48Z

Also, all the Psr0Parser has to do with PhpParser is code reuse , nothing else. It's not a drop-in replacement or anything like that. I just found that PhpParser already has next() and parseUseStatement() so I reused that.

chx · 2012-06-18T18:06:37Z

OK, I have moved the common code into a base class to extend from.

chx · 2012-06-18T18:08:30Z

Oh and if you don't like that both extend from TokenParser I can just store a TokenParser object in both.

stof · 2012-06-18T18:21:41Z

Btw, for the Cs issue, PHP-CS-Fixer should be able to fix most of them if you run it on these files

…ement. Good foundation for the upcoming parent class resolver.

chx · 2012-06-19T02:25:31Z

I will write the parent class name resolver next. With the current code I can do $parser = new Psr0Parser(drupal_classloader()->getNameSpaces(), 'Drupal\\block\\Plugins\\owner\\type\\test'); where drupal_classloader returns Symfony\Component\ClassLoader\UniversalClassLoader and in fact the file finder code itself is a straight copy out of UniversalClassLoader.

stof · 2012-06-25T08:45:52Z

lib/Doctrine/Common/Reflection/StaticReflectionClass.php

+{
+    public function __construct($psr0Parser)
+    {
+        $this->psr0Parser = $psr0Parser;


you should rename the property, and declare it (undeclared properties have a performance impact as PHP 5.4 optimized the property access for known properties)

Yes I know about that in PHP 5.4 and I really tried hard to define all, sorry skipping this one.

…e is tested in AnnotationReader.

…amed doxygen to doc comment and cs fixes.

chx · 2012-06-28T17:25:44Z

So now I have the interface we discussed. Anything else?

stof · 2012-06-28T17:27:15Z

lib/Doctrine/Common/Reflection/ReflectionInterface.php

+
+namespace Doctrine\Common\Reflection;
+
+interface ReflectionInterface {


the curly brace should be on its own line (PHP-CS-Fixer FTW 😄)

stof · 2012-06-28T17:31:06Z

lib/Doctrine/Common/Reflection/StaticReflectionParser.php

+        }
+    }
+
+    public function findFile()


@beberlei asked you to move this logic to another class implementing an interface and injected inside the parser, so that people can replace it by another implementation if they don't follow PSR-0

stof · 2012-06-28T20:49:16Z

lib/Doctrine/Common/Reflection/StaticReflectionParser.php

+     *     Only retrieve the class docComment. Presumes there is only one
+     *     statement per line.
+     */
+    public function __construct($className, $finder, $classAnnotationOptimize = FALSE)


false should be written lowercased (same for true and null but I'm not sure they appear in the PR). The PHP-CS-Fixer does not handle this currently so it has to be fixed by hand

PSR-0 annotation reader, try #2

chx added 2 commits June 16, 2012 13:30

Psr0Parser and assorted reflection classes.

ebf385a

Got the reflections working. The Psr0ClassReflection is complete, the…

43ac39b

… other two needs more exception throwing.

chx reviewed Jun 18, 2012
View reviewed changes

akkie reviewed Jun 18, 2012
View reviewed changes

chx added 2 commits June 18, 2012 09:57

Parse only on demand.

c6668c1

Code style fixes

1b7334f

stof reviewed Jun 18, 2012
View reviewed changes

Fix class hierarchy by extracting common code into a TokenParser class.

d8d8c5f

Another code style fix.

841e12c

chx added 3 commits June 18, 2012 11:26

Ran php-cs-fixer.

2c12770

More code style.

bf4a344

Lifted some code from Symfony to allow more flexibility in class plac…

11f78d8

…ement. Good foundation for the upcoming parent class resolver.

Handle parent class properly. Simplify brutally.

e15f5cc

stof reviewed Jun 25, 2012
View reviewed changes

chx added 4 commits June 25, 2012 02:06

Test the parent class logic in StaticReflectionParser. Everything els…

042829d

…e is tested in AnnotationReader.

renamed parser to static.

b38f568

Using Symfony 2.1 findFile for simplicity and underscore support, ren…

a06231c

…amed doxygen to doc comment and cs fixes.

Added a reflection interface.

fb1cb42

stof reviewed Jun 28, 2012
View reviewed changes

I really hate PSR-2.

87ddc21

stof reviewed Jun 28, 2012
View reviewed changes

chx added 5 commits June 28, 2012 10:41

more style fixes and renamed the new interface.

9721284

added public to the interface.

bad9f8e

Moved findFile to a class, added interface, renamed ns to namespace.

adef493

More code style.

b8340e0

More code style fixes thanks to the new cs fixer.

823b0d1

stof reviewed Jun 28, 2012
View reviewed changes

chx added 2 commits June 28, 2012 13:50

false

12cf440

Opsie, forgot Psr0FindFile.php

b098c07

beberlei added a commit that referenced this pull request Jun 30, 2012

Merge pull request #154 from chx/psr0annotations

d2f8a36

PSR-0 annotation reader, try #2

beberlei merged commit d2f8a36 into doctrine:master Jun 30, 2012

Majkl578 mentioned this pull request Dec 7, 2017

The future of Common 3.0 #826

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PSR-0 annotation reader, try #2 #154

PSR-0 annotation reader, try #2 #154

chx commented Jun 18, 2012

chx Jun 18, 2012

stof commented Jun 18, 2012

chx commented Jun 18, 2012

akkie Jun 18, 2012

chx Jun 18, 2012

stof Jun 18, 2012

stof Jun 18, 2012

chx Jun 18, 2012

stof commented Jun 18, 2012

stof commented Jun 18, 2012

chx commented Jun 18, 2012

stof commented Jun 18, 2012

chx commented Jun 18, 2012

chx commented Jun 18, 2012

chx commented Jun 18, 2012

stof commented Jun 18, 2012

chx commented Jun 19, 2012

stof Jun 25, 2012

chx Jun 25, 2012

chx commented Jun 28, 2012

stof Jun 28, 2012

stof Jun 28, 2012

stof Jun 28, 2012


		namespace Doctrine\Common\Reflection;

		interface ReflectionInterface {

PSR-0 annotation reader, try #2 #154

PSR-0 annotation reader, try #2 #154

Conversation

chx commented Jun 18, 2012

Choose a reason for hiding this comment

stof commented Jun 18, 2012

chx commented Jun 18, 2012

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

Choose a reason for hiding this comment

stof commented Jun 18, 2012

stof commented Jun 18, 2012

chx commented Jun 18, 2012

stof commented Jun 18, 2012

chx commented Jun 18, 2012

chx commented Jun 18, 2012

chx commented Jun 18, 2012

stof commented Jun 18, 2012

chx commented Jun 19, 2012

Choose a reason for hiding this comment

Choose a reason for hiding this comment

chx commented Jun 28, 2012

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment