class PHPDriver in Zircon Profile 8

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

@link www.doctrine-project.org @since 2.0 @author Benjamin Eberlei <[e-mail]> @author Guilherme Blanco <[e-mail]> @author Jonathan H. Wage <[e-mail]> @author Roman Borschel <[e-mail]>

Hierarchy

• class \Doctrine\Common\Persistence\Mapping\Driver\FileDriver implements MappingDriver
  • class \Doctrine\Common\Persistence\Mapping\Driver\PHPDriver

1 file declares its use of PHPDriver

PHPDriverTest.php in vendor/doctrine/common/tests/Doctrine/Tests/Common/Persistence/Mapping/PHPDriverTest.php

File

vendor/doctrine/common/lib/Doctrine/Common/Persistence/Mapping/Driver/PHPDriver.php, line 35

Namespace

Doctrine\Common\Persistence\Mapping\Driver

class PHPDriver extends FileDriver {

  /**
   * @var ClassMetadata
   */
  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

Name	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	Gets 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	Retrieves the global basename.
FileDriver::getLocator	public	function	Retrieves the locator used to discover mapping files by className.
FileDriver::initialize	protected	function	Initializes the class cache from all the global files.
FileDriver::isTransient	public	function	Returns 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	Sets the global basename.
FileDriver::setLocator	public	function	Sets 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