class PHPDriver

The PHPDriver includes php files which just populate ClassMetadataInfo instances with plain php code

@license http://www.opensource.org/licenses/lgpl-license.php LGPL @link www.doctrine-project.org @since 2.0 @version $Revision$ @author Benjamin Eberlei <kontakt@beberlei.de> @author Guilherme Blanco <guilhermeblanco@hotmail.com> @author Jonathan H. Wage <jonwage@gmail.com> @author Roman Borschel <roman@code-factory.org>

Hierarchy

Expanded class hierarchy of PHPDriver

1 file declares its use of PHPDriver
PHPDriverTest.php in drupal/core/vendor/doctrine/common/tests/Doctrine/Tests/Common/Persistence/Mapping/PHPDriverTest.php

File

drupal/core/vendor/doctrine/common/lib/Doctrine/Common/Persistence/Mapping/Driver/PHPDriver.php, line 37

Namespace

Doctrine\Common\Persistence\Mapping\Driver
View source
class PHPDriver extends FileDriver {

  /**
   * {@inheritdoc}
   */
  protected $metadata;

  /**
   * {@inheritDoc}
   */
  public function __construct($locator, $fileExtension = null) {
    $fileExtension = ".php";
    parent::__construct($locator, $fileExtension);
  }

  /**
   * {@inheritdoc}
   */
  public function loadMetadataForClass($className, ClassMetadata $metadata) {
    $this->metadata = $metadata;
    $this
      ->loadMappingFile($this->locator
      ->findMappingFile($className));
  }

  /**
   * {@inheritdoc}
   */
  protected function loadMappingFile($file) {
    $metadata = $this->metadata;
    include $file;
    return array(
      $metadata
        ->getName() => $metadata,
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
FileDriver::$classCache protected property
FileDriver::$globalBasename protected property
FileDriver::$locator protected property
FileDriver::getAllClassNames public function Gets the names of all mapped classes known to this driver. Overrides MappingDriver::getAllClassNames
FileDriver::getElement public function Get the element of schema meta data for the class from the mapping file. This will lazily load the mapping file if it is not loaded yet
FileDriver::getGlobalBasename public function Retrieve global basename
FileDriver::getLocator public function Retrieve the locator used to discover mapping files by className
FileDriver::initialize protected function Initialize the class cache from all the global files.
FileDriver::isTransient public function Whether the class with the specified name should have its metadata loaded. This is only the case if it is either mapped as an Entity or a MappedSuperclass. Overrides MappingDriver::isTransient
FileDriver::setGlobalBasename public function Set global basename
FileDriver::setLocator public function Set the locator used to discover mapping files by className
PHPDriver::$metadata protected property
PHPDriver::loadMappingFile protected function Loads a mapping file with the given name and returns a map from class/entity names to their corresponding file driver elements. Overrides FileDriver::loadMappingFile
PHPDriver::loadMetadataForClass public function Loads the metadata for the specified class into the provided container. Overrides MappingDriver::loadMetadataForClass
PHPDriver::__construct public function Initializes a new FileDriver that looks in the given path(s) for mapping documents and operates in the specified operating mode. Overrides FileDriver::__construct