Refactored the mapping drivers to use the base drivers from Common

Author: stof

lib/Doctrine/ODM/MongoDB/Configuration.php

@@ -19,7 +19,7 @@
 
 namespace Doctrine\ODM\MongoDB;
 
-use Doctrine\ODM\MongoDB\Mapping\Driver\Driver,
+use Doctrine\Common\Persistence\Mapping\Driver\MappingDriver,
     Doctrine\ODM\MongoDB\Mapping\Driver\PHPDriver,
     Doctrine\Common\Cache\Cache;
 
@@ -82,11 +82,11 @@ public function setDocumentNamespaces(array $documentNamespaces)
     /**
      * Sets the cache driver implementation that is used for metadata caching.
      *
-     * @param Driver $driverImpl
+     * @param MappingDriver $driverImpl
      * @todo Force parameter to be a Closure to ensure lazy evaluation
      *       (as soon as a metadata cache is in effect, the driver never needs to initialize).
      */
-    public function setMetadataDriverImpl(Driver $driverImpl)
+    public function setMetadataDriverImpl(MappingDriver $driverImpl)
     {
         $this->attributes['metadataDriverImpl'] = $driverImpl;
     }
@@ -107,7 +107,7 @@ public function newDefaultAnnotationDriver($paths = array())
     /**
      * Gets the cache driver implementation that is used for the mapping metadata.
      *
-     * @return Mapping\Driver\Driver
+     * @return MappingDriver
      */
     public function getMetadataDriverImpl()
     {

lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadataFactory.php

@@ -51,7 +51,7 @@ class ClassMetadataFactory extends AbstractClassMetadataFactory
     /** @var Configuration The Configuration instance */
     private $config;
 
-    /** @var \Doctrine\ODM\MongoDB\Mapping\Driver\Driver The used metadata driver. */
+    /** @var \Doctrine\Common\Persistence\Mapping\Driver\MappingDriver The used metadata driver. */
     private $driver;
 
     /** @var \Doctrine\Common\EventManager The event manager instance */

lib/Doctrine/ODM/MongoDB/Mapping/Driver/AnnotationDriver.php

@@ -22,6 +22,8 @@
 use Doctrine\Common\Annotations\AnnotationReader,
     Doctrine\Common\Annotations\AnnotationRegistry,
     Doctrine\Common\Annotations\Reader,
+    Doctrine\Common\Persistence\Mapping\ClassMetadata,
+    Doctrine\Common\Persistence\Mapping\Driver\AnnotationDriver as AbstractAnnotationDriver,
     Doctrine\ODM\MongoDB\Events,
     Doctrine\ODM\MongoDB\Mapping\Annotations as ODM,
     Doctrine\ODM\MongoDB\Mapping\ClassMetadataInfo,
@@ -36,43 +38,14 @@
  * @author      Jonathan H. Wage <jonwage@gmail.com>
  * @author      Roman Borschel <roman@code-factory.org>
  */
-class AnnotationDriver implements Driver
+class AnnotationDriver extends AbstractAnnotationDriver
 {
-    /**
-     * Document annotation classes, ordered by precedence.
-     */
-    static private $documentAnnotationClasses = array(
-        'Doctrine\\ODM\\MongoDB\\Mapping\\Annotations\\Document',
-        'Doctrine\\ODM\\MongoDB\\Mapping\\Annotations\\MappedSuperclass',
-        'Doctrine\\ODM\\MongoDB\\Mapping\\Annotations\\EmbeddedDocument',
+    protected $entityAnnotationClasses = array(
+        'Doctrine\\ODM\\MongoDB\\Mapping\\Annotations\\Document' => 1,
+        'Doctrine\\ODM\\MongoDB\\Mapping\\Annotations\\MappedSuperclass' => 2,
+        'Doctrine\\ODM\\MongoDB\\Mapping\\Annotations\\EmbeddedDocument' => 3,
     );
 
-    /**
-     * The annotation reader.
-     *
-     * @var Reader
-     */
-    private $reader;
-
-    /**
-     * The paths where to look for mapping files.
-     *
-     * @var array
-     */
-    private $paths = array();
-
-    /**
-     * The file extension of mapping documents.
-     *
-     * @var string
-     */
-    private $fileExtension = '.php';
-
-    /**
-     * @param array
-     */
-    private $classNames;
-
     /**
      * Registers annotation classes to the common registry.
      *
@@ -83,56 +56,12 @@ public static function registerAnnotationClasses()
         AnnotationRegistry::registerFile(__DIR__ . '/../Annotations/DoctrineAnnotations.php');
     }
 
-    /**
-     * Initializes a new AnnotationDriver that uses the given Reader for reading
-     * docblock annotations.
-     *
-     * @param $reader Reader The annotation reader to use.
-     * @param string|array $paths One or multiple paths where mapping classes can be found.
-     */
-    public function __construct(Reader $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;
-    }
-
     /**
      * {@inheritdoc}
      */
-    public function loadMetadataForClass($className, ClassMetadataInfo $class)
+    public function loadMetadataForClass($className, ClassMetadata $class)
     {
+        /** @var $class ClassMetadataInfo */
         $reflClass = $class->getReflectionClass();
 
         $documentAnnots = array();
@@ -288,80 +217,6 @@ private function addIndex(ClassMetadataInfo $class, $index, array $keys = array(
         $class->addIndex($keys, $options);
     }
 
-    /**
-     * 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 either (at)Entity or
-     * (at)MappedSuperclass in the class doc block.
-     *
-     * @param string $className
-     * @return boolean
-     */
-    public function isTransient($className)
-    {
-        $classAnnotations = $this->reader->getClassAnnotations(new \ReflectionClass($className));
-
-        foreach ($classAnnotations as $annot) {
-            if ($annot instanceof ODM\AbstractDocument) {
-                return false;
-            }
-        }
-
-        return true;
-    }
-
-    /**
-     * {@inheritDoc}
-     */
-    public function getAllClassNames()
-    {
-        if ($this->classNames !== null) {
-            return $this->classNames;
-        }
-
-        if ( ! $this->paths) {
-            throw MongoDBException::pathRequired();
-        }
-
-        $classes = array();
-        $includedFiles = array();
-
-        foreach ($this->paths as $path) {
-            if ( ! is_dir($path)) {
-                throw MongoDBException::fileMappingDriversRequireConfiguredDirectoryPath();
-            }
-
-            $iterator = new \RecursiveIteratorIterator(
-                new \RecursiveDirectoryIterator($path),
-                \RecursiveIteratorIterator::LEAVES_ONLY
-            );
-
-            foreach ($iterator as $file) {
-                if (($fileName = $file->getBasename($this->fileExtension)) == $file->getBasename()) {
-                    continue;
-                }
-
-                $sourceFile = realpath($file->getPathName());
-                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;
-    }
-
     /**
      * Factory method for the Annotation Driver
      *