class StaticPHPDriver in Zircon Profile 8

The StaticPHPDriver calls a static loadMetadata() method on your entity classes where you can manually populate the ClassMetadata instance.

@link www.doctrine-project.org @since 2.2 @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\StaticPHPDriver implements MappingDriver

1 file declares its use of StaticPHPDriver

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

File

vendor/doctrine/common/lib/Doctrine/Common/Persistence/Mapping/Driver/StaticPHPDriver.php, line 36

Namespace

Doctrine\Common\Persistence\Mapping\Driver

class StaticPHPDriver implements MappingDriver {

  /**
   * Paths of entity directories.
   *
   * @var array
   */
  private $paths = array();

  /**
   * Map of all class names.
   *
   * @var array
   */
  private $classNames;

  /**
   * Constructor.
   *
   * @param array|string $paths
   */
  public function __construct($paths) {
    $this
      ->addPaths((array) $paths);
  }

  /**
   * Adds paths.
   *
   * @param array $paths
   *
   * @return void
   */
  public function addPaths(array $paths) {
    $this->paths = array_unique(array_merge($this->paths, $paths));
  }

  /**
   * {@inheritdoc}
   */
  public function loadMetadataForClass($className, ClassMetadata $metadata) {
    $className::loadMetadata($metadata);
  }

  /**
   * {@inheritDoc}
   * @todo Same code exists in AnnotationDriver, should we re-use it somehow or not worry about it?
   */
  public function getAllClassNames() {
    if ($this->classNames !== null) {
      return $this->classNames;
    }
    if (!$this->paths) {
      throw MappingException::pathRequired();
    }
    $classes = array();
    $includedFiles = array();
    foreach ($this->paths as $path) {
      if (!is_dir($path)) {
        throw MappingException::fileMappingDriversRequireConfiguredDirectoryPath($path);
      }
      $iterator = new \RecursiveIteratorIterator(new \RecursiveDirectoryIterator($path), \RecursiveIteratorIterator::LEAVES_ONLY);
      foreach ($iterator as $file) {
        if ($file
          ->getBasename('.php') == $file
          ->getBasename()) {
          continue;
        }
        $sourceFile = realpath($file
          ->getPathName());
        require_once $sourceFile;
        $includedFiles[] = $sourceFile;
      }
    }
    $declared = get_declared_classes();
    foreach ($declared as $className) {
      $rc = new \ReflectionClass($className);
      $sourceFile = $rc
        ->getFileName();
      if (in_array($sourceFile, $includedFiles) && !$this
        ->isTransient($className)) {
        $classes[] = $className;
      }
    }
    $this->classNames = $classes;
    return $classes;
  }

  /**
   * {@inheritdoc}
   */
  public function isTransient($className) {
    return !method_exists($className, 'loadMetadata');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
StaticPHPDriver::$classNames	private	property	Map of all class names.
StaticPHPDriver::$paths	private	property	Paths of entity directories.
StaticPHPDriver::addPaths	public	function	Adds paths.
StaticPHPDriver::getAllClassNames	public	function	@todo Same code exists in AnnotationDriver, should we re-use it somehow or not worry about it? Overrides MappingDriver::getAllClassNames
StaticPHPDriver::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
StaticPHPDriver::loadMetadataForClass	public	function	Loads the metadata for the specified class into the provided container. Overrides MappingDriver::loadMetadataForClass
StaticPHPDriver::__construct	public	function	Constructor.