vendor/doctrine/orm/lib/Doctrine/ORM/Tools/Export/Driver/AnnotationExporter.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\ORM\Tools\Export\Driver;
  21
  22 use Doctrine\ORM\Mapping\ClassMetadataInfo,
  23     Doctrine\ORM\Tools\EntityGenerator;
  24
  25 /**
  26  * ClassMetadata exporter for PHP classes with annotations
  27  *
  28  *
  29  * @link    www.doctrine-project.org
  30  * @since   2.0
  31  * @author  Jonathan Wage <jonwage@gmail.com>
  32  */
  33 class AnnotationExporter extends AbstractExporter
  34 {
  35     protected $_extension = '.php';
  36     private $_entityGenerator;
  37
  38     /**
  39      * Converts a single ClassMetadata instance to the exported format
  40      * and returns it
  41      *
  42      * @param ClassMetadataInfo $metadata
  43      * @return string $exported
  44      */
  45     public function exportClassMetadata(ClassMetadataInfo $metadata)
  46     {
  47         if ( ! $this->_entityGenerator) {
  48             throw new \RuntimeException('For the AnnotationExporter you must set an EntityGenerator instance with the setEntityGenerator() method.');
  49         }
  50         $this->_entityGenerator->setGenerateAnnotations(true);
  51         $this->_entityGenerator->setGenerateStubMethods(false);
  52         $this->_entityGenerator->setRegenerateEntityIfExists(false);
  53         $this->_entityGenerator->setUpdateEntityIfExists(false);
  54
  55         return $this->_entityGenerator->generateEntityClass($metadata);
  56     }
  57
  58     protected function _generateOutputPath(ClassMetadataInfo $metadata)
  59     {
  60         return $this->_outputDir . '/' . str_replace('\\', '/', $metadata->name) . $this->_extension;
  61     }
  62
  63     public function setEntityGenerator(EntityGenerator $entityGenerator)
  64     {
  65         $this->_entityGenerator = $entityGenerator;
  66     }
  67 }