vendor/doctrine/common/lib/Doctrine/Common/Persistence/Mapping/Driver/PHPDriver.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
  24 /**
  25  * The PHPDriver includes php files which just populate ClassMetadataInfo
  26  * instances with plain php code
  27  *
  28  * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
  29  * @link        www.doctrine-project.org
  30  * @since       2.0
  31  * @version     $Revision$
  32  * @author      Benjamin Eberlei <kontakt@beberlei.de>
  33  * @author      Guilherme Blanco <guilhermeblanco@hotmail.com>
  34  * @author      Jonathan H. Wage <jonwage@gmail.com>
  35  * @author      Roman Borschel <roman@code-factory.org>
  36  */
  37 class PHPDriver extends FileDriver
  38 {
  39     /**
  40      * {@inheritdoc}
  41      */
  42     protected $metadata;
  43
  44     /**
  45      * {@inheritDoc}
  46      */
  47     public function __construct($locator, $fileExtension = null)
  48     {
  49         $fileExtension = ".php";
  50         parent::__construct($locator, $fileExtension);
  51     }
  52
  53     /**
  54      * {@inheritdoc}
  55      */
  56     public function loadMetadataForClass($className, ClassMetadata $metadata)
  57     {
  58         $this->metadata = $metadata;
  59         $this->loadMappingFile($this->locator->findMappingFile($className));
  60     }
  61
  62     /**
  63      * {@inheritdoc}
  64      */
  65     protected function loadMappingFile($file)
  66     {
  67         $metadata = $this->metadata;
  68         include $file;
  69
  70         return array($metadata->getName() => $metadata);
  71     }
  72 }