Doctrine Project

[DCOM-41] Make annotation parser a bit cleverer

Thu, 7 Apr 2011 14:22:01 +0000

From an initial look that I had at the annotation parser, it simply search for anything starting with an "@" somewhere in the doc comment and assumes that it is an annotation. Now, if someone uses the @ somewhere in his doc comment but not as an annotation, the parser breaks.

An example for this can be found in the Doctrine code base, the following comment will result in a parse error:

    /**
     * Annotation     ::= "@" AnnotationName ["(" [Values] ")"]
     * AnnotationName ::= QualifiedName | SimpleName | AliasedName
     * QualifiedName  ::= NameSpacePart "\" {NameSpacePart "\"}* SimpleName
     * AliasedName    ::= Alias ":" SimpleName
     * NameSpacePart  ::= identifier
     * SimpleName     ::= identifier
     * Alias          ::= identifier
     *
     * @return mixed False if it is not a valid annotation.
     */

Obviously the first @ is not used to refer to an annotation here. I think it makes sense to allow new annotations only to start at a new line, what do you think?

[DCOM-38] Annotation parser plain value types

Thu, 7 Apr 2011 15:37:15 +0000

Hi,

I posted this question in doctrine user group(https://groups.google.com/forum/?fromgroups#!topic/doctrine-user/QhAz-Yr70T0), but with no response, so I'd like to open it up here as the solution is trivial and would save me either a lot of sub-classing or prevent me from changing the doctrine library files.

This annotation

class SomeGrid {
    /**
     *  @GRID:Column(header="Reg. plate", width=80, editable=TRUE, hidden=FALSE, tooltip="Registration plate", align="left", sortable=TRUE)
     */
    public $regPlate;
}

produces the following object:

(object) Grid\Annotations\Column {
    "header"   => (string) "Reg. plate"
    "width"    => (string) "80"
    "editable" => (bool)   true
    "hidden"   => (bool)   false
    "tooltip"  => (string) "Registration plate"
    "align"    => (string) "left"
    "sortable" => (bool)   true
}

You can see the value of the width property is string even I didn't use quotes in the annotation.
The same happens with float values, but true and false values become, correctly, bool.

I found this happens because of the following fragment of code in \Doctrine\Common\Annotations\Parser and could be easily corrected by prefixing the value with the corresponding type cast (marked in red).

    case Lexer::T_STRING:
        $this->match(Lexer::T_STRING);
        return $this->lexer->token['value'];
    case Lexer::T_INTEGER:
        $this->match(Lexer::T_INTEGER);
        return (int)$this->lexer->token['value'];
    case Lexer::T_FLOAT:
        $this->match(Lexer::T_FLOAT);
        return (float)$this->lexer->token['value'];
    case Lexer::T_TRUE:
        $this->match(Lexer::T_TRUE);
        return true;
    case Lexer::T_FALSE:
        $this->match(Lexer::T_FALSE);
        return false;

The point is, in our app, some of the values go directly to browser and are processed by JavaScript. Having those values as strings breaks all kinds of mathematical operations on the client or would require additional (unnecessary) string to int/float conversions.

[DCOM-35] Change AnnotationReader cache salt

Tue, 15 Feb 2011 22:08:10 +0000

Our current AnnotationReader::$_CACHE_SALT conflicts with Symfony2 Console.

The solution is to change the CACHE_SALT from:

private static $CACHE_SALT = '@<Annot>';

To:

private static $CACHE_SALT = '@[Annot]';

[DCOM-34] calling setAutoloadAnnotationClasses on doctrine annotations reader causes fatal error

Tue, 15 Feb 2011 22:46:06 +0000

When I try to set setAutoloadAnnotationClasses(true) gives me a fatal error, call to undefined method

PHP Fatal error: Call to undefined method Doctrine\Common\Annotations\AnnotationReader::setAutoloadAnnotationClasses()