class DefaultFileLocator in Zircon Profile 8

Locates the file that contains the metadata information for a given class name.

This behavior is independent of the actual content of the file. It just detects the file which is responsible for the given class name.

@author Benjamin Eberlei <[e-mail]> @author Johannes M. Schmitt <[e-mail]>

Hierarchy

• class \Doctrine\Common\Persistence\Mapping\Driver\DefaultFileLocator implements FileLocator

2 files declare their use of DefaultFileLocator

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

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

File

vendor/doctrine/common/lib/Doctrine/Common/Persistence/Mapping/Driver/DefaultFileLocator.php, line 33

Namespace

Doctrine\Common\Persistence\Mapping\Driver

class DefaultFileLocator implements FileLocator {

  /**
   * The paths where to look for mapping files.
   *
   * @var array
   */
  protected $paths = array();

  /**
   * The file extension of mapping documents.
   *
   * @var string|null
   */
  protected $fileExtension;

  /**
   * Initializes a new FileDriver that looks in the given path(s) for mapping
   * documents and operates in the specified operating mode.
   *
   * @param string|array $paths         One or multiple paths where mapping documents can be found.
   * @param string|null  $fileExtension The file extension of mapping documents, usually prefixed with a dot.
   */
  public function __construct($paths, $fileExtension = null) {
    $this
      ->addPaths((array) $paths);
    $this->fileExtension = $fileExtension;
  }

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

  /**
   * Retrieves the defined metadata lookup paths.
   *
   * @return array
   */
  public function getPaths() {
    return $this->paths;
  }

  /**
   * Gets the file extension used to look for mapping files under.
   *
   * @return string|null
   */
  public function getFileExtension() {
    return $this->fileExtension;
  }

  /**
   * Sets the file extension used to look for mapping files under.
   *
   * @param string|null $fileExtension The file extension to set.
   *
   * @return void
   */
  public function setFileExtension($fileExtension) {
    $this->fileExtension = $fileExtension;
  }

  /**
   * {@inheritDoc}
   */
  public function findMappingFile($className) {
    $fileName = str_replace('\\', '.', $className) . $this->fileExtension;

    // Check whether file exists
    foreach ($this->paths as $path) {
      if (is_file($path . DIRECTORY_SEPARATOR . $fileName)) {
        return $path . DIRECTORY_SEPARATOR . $fileName;
      }
    }
    throw MappingException::mappingFileNotFound($className, $fileName);
  }

  /**
   * {@inheritDoc}
   */
  public function getAllClassNames($globalBasename) {
    $classes = array();
    if ($this->paths) {
      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) {
          $fileName = $file
            ->getBasename($this->fileExtension);
          if ($fileName == $file
            ->getBasename() || $fileName == $globalBasename) {
            continue;
          }

          // NOTE: All files found here means classes are not transient!
          $classes[] = str_replace('.', '\\', $fileName);
        }
      }
    }
    return $classes;
  }

  /**
   * {@inheritDoc}
   */
  public function fileExists($className) {
    $fileName = str_replace('\\', '.', $className) . $this->fileExtension;

    // Check whether file exists
    foreach ((array) $this->paths as $path) {
      if (is_file($path . DIRECTORY_SEPARATOR . $fileName)) {
        return true;
      }
    }
    return false;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DefaultFileLocator::$fileExtension	protected	property	The file extension of mapping documents.
DefaultFileLocator::$paths	protected	property	The paths where to look for mapping files.
DefaultFileLocator::addPaths	public	function	Appends lookup paths to metadata driver.
DefaultFileLocator::fileExists	public	function	Checks if a file can be found for this class name. Overrides FileLocator::fileExists
DefaultFileLocator::findMappingFile	public	function	Locates mapping file for the given class name. Overrides FileLocator::findMappingFile
DefaultFileLocator::getAllClassNames	public	function	Gets all class names that are found with this file locator. Overrides FileLocator::getAllClassNames
DefaultFileLocator::getFileExtension	public	function	Gets the file extension used to look for mapping files under. Overrides FileLocator::getFileExtension
DefaultFileLocator::getPaths	public	function	Retrieves the defined metadata lookup paths. Overrides FileLocator::getPaths
DefaultFileLocator::setFileExtension	public	function	Sets the file extension used to look for mapping files under.
DefaultFileLocator::__construct	public	function	Initializes a new FileDriver that looks in the given path(s) for mapping documents and operates in the specified operating mode.