www.aleph1.co.uk Git - yaffs-website/blob - vendor/doctrine/common/lib/Doctrine/Common/Persistence/Mapping/Driver/MappingDriverChain.php

   1 <?php
   2 /*
   3  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   4  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   5  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   6  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   7  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   8  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   9  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14  *
  15  * This software consists of voluntary contributions made by many individuals
  16  * and is licensed under the MIT license. For more information, see
  17  * <http://www.doctrine-project.org>.
  18  */
  19
  20 namespace Doctrine\Common\Persistence\Mapping\Driver;
  21
  22 use Doctrine\Common\Persistence\Mapping\ClassMetadata;
  23 use Doctrine\Common\Persistence\Mapping\MappingException;
  24
  25 /**
  26  * The DriverChain allows you to add multiple other mapping drivers for
  27  * certain namespaces.
  28  *
  29  * @since  2.2
  30  * @author Benjamin Eberlei <kontakt@beberlei.de>
  31  * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
  32  * @author Jonathan H. Wage <jonwage@gmail.com>
  33  * @author Roman Borschel <roman@code-factory.org>
  34  */
  35 class MappingDriverChain implements MappingDriver
  36 {
  37     /**
  38      * The default driver.
  39      *
  40      * @var MappingDriver|null
  41      */
  42     private $defaultDriver;
  43
  44     /**
  45      * @var array
  46      */
  47     private $drivers = [];
  48
  49     /**
  50      * Gets the default driver.
  51      *
  52      * @return MappingDriver|null
  53      */
  54     public function getDefaultDriver()
  55     {
  56         return $this->defaultDriver;
  57     }
  58
  59     /**
  60      * Set the default driver.
  61      *
  62      * @param MappingDriver $driver
  63      *
  64      * @return void
  65      */
  66     public function setDefaultDriver(MappingDriver $driver)
  67     {
  68         $this->defaultDriver = $driver;
  69     }
  70
  71     /**
  72      * Adds a nested driver.
  73      *
  74      * @param MappingDriver $nestedDriver
  75      * @param string        $namespace
  76      *
  77      * @return void
  78      */
  79     public function addDriver(MappingDriver $nestedDriver, $namespace)
  80     {
  81         $this->drivers[$namespace] = $nestedDriver;
  82     }
  83
  84     /**
  85      * Gets the array of nested drivers.
  86      *
  87      * @return array $drivers
  88      */
  89     public function getDrivers()
  90     {
  91         return $this->drivers;
  92     }
  93
  94     /**
  95      * {@inheritDoc}
  96      */
  97     public function loadMetadataForClass($className, ClassMetadata $metadata)
  98     {
  99         /* @var $driver MappingDriver */
 100         foreach ($this->drivers as $namespace => $driver) {
 101             if (strpos($className, $namespace) === 0) {
 102                 $driver->loadMetadataForClass($className, $metadata);
 103                 return;
 104             }
 105         }
 106
 107         if (null !== $this->defaultDriver) {
 108             $this->defaultDriver->loadMetadataForClass($className, $metadata);
 109             return;
 110         }
 111
 112         throw MappingException::classNotFoundInNamespaces($className, array_keys($this->drivers));
 113     }
 114
 115     /**
 116      * {@inheritDoc}
 117      */
 118     public function getAllClassNames()
 119     {
 120         $classNames = [];
 121         $driverClasses = [];
 122
 123         /* @var $driver MappingDriver */
 124         foreach ($this->drivers AS $namespace => $driver) {
 125             $oid = spl_object_hash($driver);
 126
 127             if (!isset($driverClasses[$oid])) {
 128                 $driverClasses[$oid] = $driver->getAllClassNames();
 129             }
 130
 131             foreach ($driverClasses[$oid] AS $className) {
 132                 if (strpos($className, $namespace) === 0) {
 133                     $classNames[$className] = true;
 134                 }
 135             }
 136         }
 137
 138         if (null !== $this->defaultDriver) {
 139             foreach ($this->defaultDriver->getAllClassNames() as $className) {
 140                 $classNames[$className] = true;
 141             }
 142         }
 143
 144         return array_keys($classNames);
 145     }
 146
 147     /**
 148      * {@inheritDoc}
 149      */
 150     public function isTransient($className)
 151     {
 152         /* @var $driver MappingDriver */
 153         foreach ($this->drivers AS $namespace => $driver) {
 154             if (strpos($className, $namespace) === 0) {
 155                 return $driver->isTransient($className);
 156             }
 157         }
 158
 159         if ($this->defaultDriver !== null) {
 160             return $this->defaultDriver->isTransient($className);
 161         }
 162
 163         return true;
 164     }
 165 }