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  * @link   www.doctrine-project.org
  29  * @since  2.0
  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 PHPDriver extends FileDriver
  36 {
  37     /**
  38      * @var ClassMetadata
  39      */
  40     protected $metadata;
  41
  42     /**
  43      * {@inheritDoc}
  44      */
  45     public function __construct($locator, $fileExtension = null)
  46     {
  47         parent::__construct($locator, '.php');
  48     }
  49
  50     /**
  51      * {@inheritDoc}
  52      */
  53     public function loadMetadataForClass($className, ClassMetadata $metadata)
  54     {
  55         $this->metadata = $metadata;
  56
  57         $this->loadMappingFile($this->locator->findMappingFile($className));
  58     }
  59
  60     /**
  61      * {@inheritDoc}
  62      */
  63     protected function loadMappingFile($file)
  64     {
  65         $metadata = $this->metadata;
  66         include $file;
  67
  68         return [$metadata->getName() => $metadata];
  69     }
  70 }