AnnotationReader.php

Ir para a documentação deste ficheiro.

<?php
/*
 * 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 Closure,
    ReflectionClass,
    ReflectionMethod, 
    ReflectionProperty,
    Doctrine\Common\Cache\Cache;
 
class AnnotationReader
{
    private static $CACHE_SALT = '@<Annot>';
    
    private $parser;
    
    private $cache;
    
    public function __construct(Cache $cache = null, Parser $parser = null)
    {
        $this->parser = $parser ?: new Parser;
        $this->cache = $cache ?: new \Doctrine\Common\Cache\ArrayCache;
    }
 
    public function setDefaultAnnotationNamespace($defaultNamespace)
    {
        $this->parser->setDefaultAnnotationNamespace($defaultNamespace);
    }
 
    public function setAnnotationCreationFunction(Closure $func)
    {
        $this->parser->setAnnotationCreationFunction($func);
    }
 
    public function setAnnotationNamespaceAlias($namespace, $alias)
    {
        $this->parser->setAnnotationNamespaceAlias($namespace, $alias);
    }
 
    public function setAutoloadAnnotations($bool)
    {
        $this->parser->setAutoloadAnnotations($bool);
    }
 
    public function getAutoloadAnnotations()
    {
        return $this->parser->getAutoloadAnnotations();
    }
 
    public function getClassAnnotations(ReflectionClass $class)
    {
        $cacheKey = $class->getName() . self::$CACHE_SALT;
 
        // Attempt to grab data from cache
        if (($data = $this->cache->fetch($cacheKey)) !== false) {
            return $data;
        }
        
        $annotations = $this->parser->parse($class->getDocComment(), 'class ' . $class->getName());
        $this->cache->save($cacheKey, $annotations, null);
        
        return $annotations;
    }
 
    public function getClassAnnotation(ReflectionClass $class, $annotation)
    {
        $annotations = $this->getClassAnnotations($class);
 
        return isset($annotations[$annotation]) ? $annotations[$annotation] : null;
    }
    
    public function getPropertyAnnotations(ReflectionProperty $property)
    {
        $cacheKey = $property->getDeclaringClass()->getName() . '$' . $property->getName() . self::$CACHE_SALT;
 
        // Attempt to grab data from cache
        if (($data = $this->cache->fetch($cacheKey)) !== false) {
            return $data;
        }
        
        $context = 'property ' . $property->getDeclaringClass()->getName() . "::\$" . $property->getName();
        $annotations = $this->parser->parse($property->getDocComment(), $context);
        $this->cache->save($cacheKey, $annotations, null);
        
        return $annotations;
    }
    
    public function getPropertyAnnotation(ReflectionProperty $property, $annotation)
    {
        $annotations = $this->getPropertyAnnotations($property);
 
        return isset($annotations[$annotation]) ? $annotations[$annotation] : null;
    }
    
    public function getMethodAnnotations(ReflectionMethod $method)
    {
        $cacheKey = $method->getDeclaringClass()->getName() . '#' . $method->getName() . self::$CACHE_SALT;
 
        // Attempt to grab data from cache
        if (($data = $this->cache->fetch($cacheKey)) !== false) {
            return $data;
        } 
 
        $context = 'method ' . $method->getDeclaringClass()->getName() . '::' . $method->getName() . '()';
        $annotations = $this->parser->parse($method->getDocComment(), $context);
        $this->cache->save($cacheKey, $annotations, null);
        
        return $annotations;
    }
    
    public function getMethodAnnotation(ReflectionMethod $method, $annotation)
    {
        $annotations = $this->getMethodAnnotations($method);
        
        return isset($annotations[$annotation]) ? $annotations[$annotation] : null;
    }
}