Skip to content

D
doctrine-dbal
Commit 0515d9ab authored by romanb's avatar romanb
Browse files
Options

[2.0] New Annotation API work: Simplifications, changed namespace separator to... 

[2.0] New Annotation API work: Simplifications, changed namespace separator to match the one of PHP, adjusted Lexer to swallow any * characters outside of a string value to be more forgiving when it comes to formatting.
parent 9075f10b
Hide whitespace changes
Inline Side-by-side
Showing with 88 additions and 51 deletions
lib/Doctrine/Common/Annotations/AnnotationReader.php
View file @ 0515d9ab
<?php
/*
* $Id$
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
* This software consists of voluntary contributions made by many individuals
* and is licensed under the LGPL. For more information, see
* <http://www.doctrine-project.org>.
*/
namespace Doctrine\Common\Annotations;
use \ReflectionClass, \ReflectionMethod, \ReflectionProperty;
use Doctrine\Common\Cache\Cache;
/**
* A reader for docblock annotations.
*
* @author Roman Borschel <roman@code-factory.org>
* @since 2.0
*/
class AnnotationReader
{
private static $CACHE_SALT = "@<Annot>";
......@@ -12,12 +37,22 @@ class AnnotationReader
private $_cache;
private $_annotations = array();
/**
* Initiaizes a new AnnotationReader that uses the given Cache provider to cache annotations.
*
* @param Cache $cache The cache provider to use.
*/
public function __construct(Cache $cache)
{
$this->_parser = new Parser;
$this->_cache = $cache;
}
/**
*
* @param $defaultNamespace
* @return unknown_type
*/
public function setDefaultAnnotationNamespace($defaultNamespace)
{
$this->_parser->setDefaultAnnotationNamespace($defaultNamespace);
......@@ -30,13 +65,9 @@ class AnnotationReader
* the class annotations should be read.
* @return array An array of Annotations.
*/
public function getClassAnnotations($class)
public function getClassAnnotations(ReflectionClass $class)
{
if (is_string($class)) {
$className = $class;
} else {
$className = $class->getName();
}
$className = $class->getName();
if (isset($this->_annotations[$className])) {
return $this->_annotations[$className];
......@@ -45,16 +76,18 @@ class AnnotationReader
return $this->_annotations[$className];
}
if (is_string($class)) {
$class = new ReflectionClass($className);
}
$this->_annotations[$className] = $this->_parser->parse($class->getDocComment());
return $this->_annotations[$className];
}
public function getClassAnnotation($class, $annotation)
/**
*
* @param $class
* @param $annotation
* @return unknown_type
*/
public function getClassAnnotation(ReflectionClass $class, $annotation)
{
$annotations = $this->getClassAnnotations($class);
return isset($annotations[$annotation]) ? $annotations[$annotation] : null;
......@@ -68,14 +101,9 @@ class AnnotationReader
* from which the annotations should be read.
* @return array An array of Annotations.
*/
public function getPropertyAnnotations($class, $property)
public function getPropertyAnnotations(ReflectionProperty $property)
{
$className = is_string($class) ? $class : $class->getName();
if (is_string($property)) {
$propertyName = $className . '$' . $property;
} else {
$propertyName = $className . '$' . $property->getName();
}
$propertyName = $property->getDeclaringClass()->getName() . '$' . $property->getName();
if (isset($this->_annotations[$propertyName])) {
return $this->_annotations[$propertyName];
......@@ -84,18 +112,20 @@ class AnnotationReader
return $this->_annotations[$propertyName];
}
if (is_string($property)) {
$property = new ReflectionProperty($className, $property);
}
$this->_annotations[$propertyName] = $this->_parser->parse($property->getDocComment());
return $this->_annotations[$propertyName];
}
public function getPropertyAnnotation($class, $property, $annotation)
/**
*
* @param $property
* @param $annotation
* @return unknown_type
*/
public function getPropertyAnnotation(ReflectionProperty $property, $annotation)
{
$annotations = $this->getPropertyAnnotations($class, $property);
$annotations = $this->getPropertyAnnotations($property);
return isset($annotations[$annotation]) ? $annotations[$annotation] : null;
}
......@@ -107,14 +137,9 @@ class AnnotationReader
* the annotations should be read.
* @return array An array of Annotations.
*/
public function getMethodAnnotations($class, $method)
public function getMethodAnnotations(ReflectionMethod $method)
{
$className = is_string($class) ? $class : $class->getName();
if (is_string($method)) {
$methodName = $className . '#' . $method;
} else {
$methodName = $className . '#' . $method->getName();
}
$methodName = $method->getDeclaringClass()->getName() . '#' . $method->getName();
if (isset($this->_annotations[$methodName])) {
return $this->_annotations[$methodName];
......@@ -123,18 +148,20 @@ class AnnotationReader
return $this->_annotations[$methodName];
}
if (is_string($method)) {
$method = new ReflectionMethod($className, $method);
}
$this->_annotations[$methodName] = $this->_parser->parse($method->getDocComment());
return $this->_annotations[$methodName];
}
public function getMethodAnnotation($class, $method, $annotation)
/**
*
* @param $method
* @param $annotation
* @return unknown_type
*/
public function getMethodAnnotation(ReflectionMethod $method, $annotation)
{
$annotations = $this->getMethodAnnotations($class, $method);
$annotations = $this->getMethodAnnotations($method);
return isset($annotations[$annotation]) ? $annotations[$annotation] : null;
}
}
\ No newline at end of file
lib/Doctrine/Common/Annotations/Lexer.php
View file @ 0515d9ab
......@@ -151,7 +151,7 @@ class Lexer
'(?:[0-9]+(?:[\.][0-9]+)*)(?:e[+-]?[0-9]+)?',
'"(?:[^"]|"")*"'
);
$regex = '/(' . implode(')|(', $patterns) . ')|\s+|(.)/i';
$regex = '/(' . implode(')|(', $patterns) . ')|\s+|\*+|(.)/i';
}
$matches = preg_split($regex, $input, -1, PREG_SPLIT_NO_EMPTY | PREG_SPLIT_DELIM_CAPTURE);
......
lib/Doctrine/Common/Annotations/Parser.php
View file @ 0515d9ab
......@@ -39,6 +39,13 @@ class Parser
$this->_defaultAnnotationNamespace = $defaultNamespace;
}
/**
* Sets an alias for an annotation namespace.
*
* @param $namespace
* @param $alias
* @return unknown_type
*/
public function setAnnotationNamespaceAlias($namespace, $alias)
{
$this->_namespaceAliases[$alias] = $namespace;
......@@ -139,7 +146,7 @@ class Parser
* Annotation ::= "@" AnnotationName [ "(" [Values] ")" ]
* AnnotationName ::= SimpleName | QualifiedName
* SimpleName ::= identifier
* QualifiedName ::= NameSpacePart "." (NameSpacePart ".")* SimpleName
* QualifiedName ::= NameSpacePart "\" (NameSpacePart "\")* SimpleName
* NameSpacePart ::= identifier
*/
public function Annotation()
......@@ -150,8 +157,8 @@ class Parser
$this->match('@');
$this->match(Lexer::T_IDENTIFIER);
$nameParts[] = $this->_lexer->token['value'];
while ($this->_lexer->isNextToken('.')) {
$this->match('.');
while ($this->_lexer->isNextToken('\\')) {
$this->match('\\');
$this->match(Lexer::T_IDENTIFIER);
$nameParts[] = $this->_lexer->token['value'];
}
......
tests/Doctrine/Tests/Common/Annotations/AnnotationReaderTest.php
View file @ 0515d9ab
......@@ -21,18 +21,21 @@ class AnnotationReaderTest extends \Doctrine\Tests\DoctrineTestCase
$this->assertTrue($classAnnots[$annotName] instanceof DummyAnnotation);
$this->assertEquals("hello", $classAnnots[$annotName]->dummyValue);
$propAnnots = $reader->getPropertyAnnotations($class, 'field1');
$field1Prop = $class->getProperty('field1');
$propAnnots = $reader->getPropertyAnnotations($field1Prop);
$this->assertEquals(1, count($propAnnots));
$this->assertTrue($propAnnots[$annotName] instanceof DummyAnnotation);
$this->assertEquals("fieldHello", $propAnnots[$annotName]->dummyValue);
$methodAnnots = $reader->getMethodAnnotations($class, 'getField1');
$getField1Method = $class->getMethod('getField1');
$methodAnnots = $reader->getMethodAnnotations($getField1Method);
$this->assertEquals(1, count($methodAnnots));
$this->assertTrue($methodAnnots[$annotName] instanceof DummyAnnotation);
$this->assertEquals("methodHello", $methodAnnots[$annotName]->dummyValue);
$this->assertEquals(array(array(1, 2, "three")), $methodAnnots[$annotName]->value);
$propAnnots = $reader->getPropertyAnnotations($class, 'field2');
$field2Prop = $class->getProperty('field2');
$propAnnots = $reader->getPropertyAnnotations($field2Prop);
$this->assertEquals(1, count($propAnnots));
$this->assertTrue(isset($propAnnots['Doctrine\Tests\Common\Annotations\DummyJoinTable']));
$joinTableAnnot = $propAnnots['Doctrine\Tests\Common\Annotations\DummyJoinTable'];
......@@ -65,12 +68,12 @@ class DummyClass {
/**
* @DummyJoinTable(name="join_table",
joinColumns={
@DummyJoinColumn(name="col1", referencedColumnName="col2")
},
inverseJoinColumns={
@DummyJoinColumn(name="col3", referencedColumnName="col4")
})
* joinColumns={
* @DummyJoinColumn(name="col1", referencedColumnName="col2")
* },
* inverseJoinColumns={
* @DummyJoinColumn(name="col3", referencedColumnName="col4")
* })
*/
private $field2;
......
tests/Doctrine/Tests/Common/Annotations/ParserTest.php
View file @ 0515d9ab
......@@ -75,7 +75,7 @@ DOCBLOCK;
* Some nifty class.
*
* @author Mr.X
* @Doctrine.Tests.Common.Annotations.Name(foo="bar")
* @Doctrine\Tests\Common\Annotations\Name(foo="bar")
*/
DOCBLOCK;
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment