215 lines
5.9 KiB
PHP
215 lines
5.9 KiB
PHP
<?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\Persistence\Mapping\Driver;
|
|
|
|
use Doctrine\Common\Cache\ArrayCache,
|
|
Doctrine\Common\Annotations\AnnotationReader,
|
|
Doctrine\Common\Annotations\AnnotationRegistry,
|
|
Doctrine\Common\Persistence\Mapping\MappingException;
|
|
|
|
/**
|
|
* The AnnotationDriver reads the mapping metadata from docblock annotations.
|
|
*
|
|
* @since 2.2
|
|
* @author Benjamin Eberlei <kontakt@beberlei.de>
|
|
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
|
|
* @author Jonathan H. Wage <jonwage@gmail.com>
|
|
* @author Roman Borschel <roman@code-factory.org>
|
|
*/
|
|
abstract class AnnotationDriver implements MappingDriver
|
|
{
|
|
/**
|
|
* The AnnotationReader.
|
|
*
|
|
* @var AnnotationReader
|
|
*/
|
|
protected $reader;
|
|
|
|
/**
|
|
* The paths where to look for mapping files.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $paths = array();
|
|
|
|
/**
|
|
* The file extension of mapping documents.
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $fileExtension = '.php';
|
|
|
|
/**
|
|
* Cache for AnnotationDriver#getAllClassNames()
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $classNames;
|
|
|
|
/**
|
|
* Name of the entity annotations as keys
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $entityAnnotationClasses = array();
|
|
|
|
/**
|
|
* Initializes a new AnnotationDriver that uses the given AnnotationReader for reading
|
|
* docblock annotations.
|
|
*
|
|
* @param AnnotationReader $reader The AnnotationReader to use, duck-typed.
|
|
* @param string|array $paths One or multiple paths where mapping classes can be found.
|
|
*/
|
|
public function __construct($reader, $paths = null)
|
|
{
|
|
$this->reader = $reader;
|
|
if ($paths) {
|
|
$this->addPaths((array) $paths);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Append lookup paths to metadata driver.
|
|
*
|
|
* @param array $paths
|
|
*/
|
|
public function addPaths(array $paths)
|
|
{
|
|
$this->paths = array_unique(array_merge($this->paths, $paths));
|
|
}
|
|
|
|
/**
|
|
* Retrieve the defined metadata lookup paths.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getPaths()
|
|
{
|
|
return $this->paths;
|
|
}
|
|
|
|
/**
|
|
* Retrieve the current annotation reader
|
|
*
|
|
* @return AnnotationReader
|
|
*/
|
|
public function getReader()
|
|
{
|
|
return $this->reader;
|
|
}
|
|
|
|
/**
|
|
* Get the file extension used to look for mapping files under
|
|
*
|
|
* @return void
|
|
*/
|
|
public function getFileExtension()
|
|
{
|
|
return $this->fileExtension;
|
|
}
|
|
|
|
/**
|
|
* Set the file extension used to look for mapping files under
|
|
*
|
|
* @param string $fileExtension The file extension to set
|
|
* @return void
|
|
*/
|
|
public function setFileExtension($fileExtension)
|
|
{
|
|
$this->fileExtension = $fileExtension;
|
|
}
|
|
|
|
/**
|
|
* Whether the class with the specified name is transient. Only non-transient
|
|
* classes, that is entities and mapped superclasses, should have their metadata loaded.
|
|
*
|
|
* A class is non-transient if it is annotated with an annotation
|
|
* from the {@see AnnotationDriver::entityAnnotationClasses}.
|
|
*
|
|
* @param string $className
|
|
* @return boolean
|
|
*/
|
|
public function isTransient($className)
|
|
{
|
|
$classAnnotations = $this->reader->getClassAnnotations(new \ReflectionClass($className));
|
|
|
|
foreach ($classAnnotations as $annot) {
|
|
if (isset($this->entityAnnotationClasses[get_class($annot)])) {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* {@inheritDoc}
|
|
*/
|
|
public function getAllClassNames()
|
|
{
|
|
if ($this->classNames !== null) {
|
|
return $this->classNames;
|
|
}
|
|
|
|
if (!$this->paths) {
|
|
throw MappingException::pathRequired();
|
|
}
|
|
|
|
$classes = array();
|
|
$includedFiles = array();
|
|
|
|
foreach ($this->paths as $path) {
|
|
if ( ! is_dir($path)) {
|
|
throw MappingException::fileMappingDriversRequireConfiguredDirectoryPath($path);
|
|
}
|
|
|
|
$iterator = new \RegexIterator(
|
|
new \RecursiveIteratorIterator(
|
|
new \RecursiveDirectoryIterator($path, \FilesystemIterator::SKIP_DOTS),
|
|
\RecursiveIteratorIterator::LEAVES_ONLY
|
|
),
|
|
'/^.+' . str_replace('.', '\.', $this->fileExtension) . '$/i',
|
|
\RecursiveRegexIterator::GET_MATCH
|
|
);
|
|
|
|
foreach ($iterator as $file) {
|
|
$sourceFile = realpath($file[0]);
|
|
|
|
require_once $sourceFile;
|
|
|
|
$includedFiles[] = $sourceFile;
|
|
}
|
|
}
|
|
|
|
$declared = get_declared_classes();
|
|
|
|
foreach ($declared as $className) {
|
|
$rc = new \ReflectionClass($className);
|
|
$sourceFile = $rc->getFileName();
|
|
if (in_array($sourceFile, $includedFiles) && ! $this->isTransient($className)) {
|
|
$classes[] = $className;
|
|
}
|
|
}
|
|
|
|
$this->classNames = $classes;
|
|
|
|
return $classes;
|
|
}
|
|
}
|