/htdocs/symfony/2.0.0pr3/src/vendor/doctrine-mongodb/lib/Doctrine/ODM/MongoDB/Mapping/Driver/AnnotationDriver.php
PHP | 370 lines | 245 code | 42 blank | 83 comment | 49 complexity | a684cde75daaf532a1f2219a6fc6d08e MD5 | raw file
- <?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\ODM\MongoDB\Mapping\Driver;
- use Doctrine\ODM\MongoDB\Mapping\ClassMetadata,
- Doctrine\Common\Annotations\AnnotationReader,
- Doctrine\ODM\MongoDB\MongoDBException;
- require __DIR__ . '/DoctrineAnnotations.php';
- /**
- * The AnnotationDriver reads the mapping metadata from docblock annotations.
- *
- * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
- * @link www.doctrine-project.org
- * @since 1.0
- * @author Jonathan H. Wage <jonwage@gmail.com>
- * @author Roman Borschel <roman@code-factory.org>
- */
- class AnnotationDriver implements Driver
- {
- /**
- * The AnnotationReader.
- *
- * @var AnnotationReader
- */
- 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;
- /**
- * Initializes a new AnnotationDriver that uses the given AnnotationReader for reading
- * docblock annotations.
- *
- * @param $reader The AnnotationReader to use.
- * @param string|array $paths One or multiple paths where mapping classes can be found.
- */
- public function __construct(AnnotationReader $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;
- }
- /**
- * {@inheritdoc}
- */
- public function loadMetadataForClass($className, ClassMetadata $class)
- {
- $reflClass = $class->getReflectionClass();
- $classAnnotations = $this->reader->getClassAnnotations($reflClass);
- if (isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\Document'])) {
- $documentAnnot = $classAnnotations['Doctrine\ODM\MongoDB\Mapping\Document'];
- } elseif (isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\MappedSuperclass'])) {
- $documentAnnot = $classAnnotations['Doctrine\ODM\MongoDB\Mapping\MappedSuperclass'];
- $class->isMappedSuperclass = true;
- } elseif (isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\EmbeddedDocument'])) {
- $documentAnnot = $classAnnotations['Doctrine\ODM\MongoDB\Mapping\EmbeddedDocument'];
- $class->isEmbeddedDocument = true;
- } else {
- throw MongoDBException::classIsNotAValidDocument($className);
- }
- if (isset($documentAnnot->db)) {
- $class->setDB($documentAnnot->db);
- }
- if (isset($documentAnnot->collection)) {
- $class->setCollection($documentAnnot->collection);
- }
- if (isset($documentAnnot->repositoryClass)) {
- $class->setCustomRepositoryClass($documentAnnot->repositoryClass);
- }
- if (isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\Indexes'])) {
- $indexes = $classAnnotations['Doctrine\ODM\MongoDB\Mapping\Indexes']->value;
- $indexes = is_array($indexes) ? $indexes : array($indexes);
- foreach ($indexes as $index) {
- $this->addIndex($class, $index);
- }
- }
- if (isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\Index'])) {
- $index = $classAnnotations['Doctrine\ODM\MongoDB\Mapping\Index'];
- $this->addIndex($class, $index);
- }
- if (isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\UniqueIndex'])) {
- $index = $classAnnotations['Doctrine\ODM\MongoDB\Mapping\UniqueIndex'];
- $this->addIndex($class, $index);
- }
- if (isset($documentAnnot->indexes)) {
- foreach($documentAnnot->indexes as $index) {
- $this->addIndex($class, $index);
- }
- }
- if (isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\InheritanceType'])) {
- $inheritanceTypeAnnot = $classAnnotations['Doctrine\ODM\MongoDB\Mapping\InheritanceType'];
- $class->setInheritanceType(constant('Doctrine\ODM\MongoDB\Mapping\ClassMetadata::INHERITANCE_TYPE_' . $inheritanceTypeAnnot->value));
- }
- if (isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\DiscriminatorField'])) {
- $discrFieldAnnot = $classAnnotations['Doctrine\ODM\MongoDB\Mapping\DiscriminatorField'];
- $class->setDiscriminatorField(array(
- 'fieldName' => $discrFieldAnnot->fieldName,
- ));
- }
- if (isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\DiscriminatorMap'])) {
- $discrMapAnnot = $classAnnotations['Doctrine\ODM\MongoDB\Mapping\DiscriminatorMap'];
- $class->setDiscriminatorMap($discrMapAnnot->value);
- }
- if (isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\DiscriminatorValue'])) {
- $discrValueAnnot = $classAnnotations['Doctrine\ODM\MongoDB\Mapping\DiscriminatorValue'];
- $class->setDiscriminatorValue($discrValueAnnot->value);
- }
- if (isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\ChangeTrackingPolicy'])) {
- $changeTrackingAnnot = $classAnnotations['Doctrine\ODM\MongoDB\Mapping\ChangeTrackingPolicy'];
- $class->setChangeTrackingPolicy(constant('Doctrine\ODM\MongoDB\Mapping\ClassMetadata::CHANGETRACKING_' . $changeTrackingAnnot->value));
- }
- $methods = $reflClass->getMethods();
- foreach ($reflClass->getProperties() as $property) {
- if ($class->isMappedSuperclass && ! $property->isPrivate()
- || $class->isInheritedField($property->name)) {
- continue;
- }
- $mapping = array();
- $mapping['fieldName'] = $property->getName();
- if ($alsoLoad = $this->reader->getPropertyAnnotation($property, 'Doctrine\ODM\MongoDB\Mapping\AlsoLoad')) {
- $mapping['alsoLoadFields'] = (array) $alsoLoad->value;
- }
- if ($notSaved = $this->reader->getPropertyAnnotation($property, 'Doctrine\ODM\MongoDB\Mapping\NotSaved')) {
- $mapping['notSaved'] = true;
- }
- $indexes = $this->reader->getPropertyAnnotation($property, 'Doctrine\ODM\MongoDB\Mapping\Indexes');
- $indexes = $indexes ? $indexes : array();
- if ($index = $this->reader->getPropertyAnnotation($property, 'Doctrine\ODM\MongoDB\Mapping\Index')) {
- $indexes[] = $index;
- }
- if ($index = $this->reader->getPropertyAnnotation($property, 'Doctrine\ODM\MongoDB\Mapping\UniqueIndex')) {
- $indexes[] = $index;
- }
- if ($indexes) {
- foreach ($indexes as $index) {
- $keys = array();
- $keys[$mapping['fieldName']] = 'asc';
- if (isset($index->order)) {
- $keys[$mapping['fieldName']] = $index->order;
- }
- $this->addIndex($class, $index, $keys);
- }
- }
- foreach ($this->reader->getPropertyAnnotations($property) as $fieldAnnot) {
- if ($fieldAnnot instanceof \Doctrine\ODM\MongoDB\Mapping\Field) {
- if ($fieldAnnot instanceof \Doctrine\ODM\MongoDB\Mapping\Id && $fieldAnnot->custom) {
- $fieldAnnot->type = 'custom_id';
- $class->setAllowCustomId(true);
- }
- $mapping = array_merge($mapping, (array) $fieldAnnot);
- $class->mapField($mapping);
- }
- }
- }
- foreach ($methods as $method) {
- if ($method->isPublic()) {
- if ($alsoLoad = $this->reader->getMethodAnnotation($method, 'Doctrine\ODM\MongoDB\Mapping\AlsoLoad')) {
- $fields = (array) $alsoLoad->value;
- foreach ($fields as $value) {
- $class->alsoLoadMethods[$value] = $method->getName();
- }
- }
- }
- }
- if (isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\HasLifecycleCallbacks'])) {
- foreach ($methods as $method) {
- if ($method->isPublic()) {
- $annotations = $this->reader->getMethodAnnotations($method);
- if (isset($annotations['Doctrine\ODM\MongoDB\Mapping\PrePersist'])) {
- $class->addLifecycleCallback($method->getName(), \Doctrine\ODM\MongoDB\ODMEvents::prePersist);
- }
- if (isset($annotations['Doctrine\ODM\MongoDB\Mapping\PostPersist'])) {
- $class->addLifecycleCallback($method->getName(), \Doctrine\ODM\MongoDB\ODMEvents::postPersist);
- }
- if (isset($annotations['Doctrine\ODM\MongoDB\Mapping\PreUpdate'])) {
- $class->addLifecycleCallback($method->getName(), \Doctrine\ODM\MongoDB\ODMEvents::preUpdate);
- }
- if (isset($annotations['Doctrine\ODM\MongoDB\Mapping\PostUpdate'])) {
- $class->addLifecycleCallback($method->getName(), \Doctrine\ODM\MongoDB\ODMEvents::postUpdate);
- }
- if (isset($annotations['Doctrine\ODM\MongoDB\Mapping\PreRemove'])) {
- $class->addLifecycleCallback($method->getName(), \Doctrine\ODM\MongoDB\ODMEvents::preRemove);
- }
- if (isset($annotations['Doctrine\ODM\MongoDB\Mapping\PostRemove'])) {
- $class->addLifecycleCallback($method->getName(), \Doctrine\ODM\MongoDB\ODMEvents::postRemove);
- }
- if (isset($annotations['Doctrine\ODM\MongoDB\Mapping\PreLoad'])) {
- $class->addLifecycleCallback($method->getName(), \Doctrine\ODM\MongoDB\ODMEvents::preLoad);
- }
- if (isset($annotations['Doctrine\ODM\MongoDB\Mapping\PostLoad'])) {
- $class->addLifecycleCallback($method->getName(), \Doctrine\ODM\MongoDB\ODMEvents::postLoad);
- }
- }
- }
- }
- }
- private function addIndex(ClassMetadata $class, $index, array $keys = array())
- {
- $keys = array_merge($keys, $index->keys);
- $options = array();
- $allowed = array('name', 'dropDups', 'background', 'safe', 'unique');
- foreach ($allowed as $name) {
- if (isset($index->$name)) {
- $options[$name] = $index->$name;
- }
- }
- $options = array_merge($options, $index->options);
- $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 @Entity or
- * @MappedSuperclass in the class doc block.
- *
- * @param string $className
- * @return boolean
- */
- public function isTransient($className)
- {
- $classAnnotations = $this->reader->getClassAnnotations(new \ReflectionClass($className));
- return ! isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\Document']) &&
- ! isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\MappedSuperclass']) &&
- ! isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\EmbeddedDocument']);
- }
- /**
- * {@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
- *
- * @param array|string $paths
- * @param AnnotationReader $reader
- * @return AnnotationDriver
- */
- static public function create($paths = array(), AnnotationReader $reader = null)
- {
- if ($reader == null) {
- $reader = new AnnotationReader();
- $reader->setDefaultAnnotationNamespace('Doctrine\ODM\MongoDB\Mapping\\');
- }
- return new self($reader, $paths);
- }
- }