class SymfonyFileLocator in Zircon Profile 8

The Symfony File Locator makes a simplifying assumptions compared to the DefaultFileLocator. By assuming paths only contain entities of a certain namespace the mapping files consists of the short classname only.

@author Fabien Potencier <[e-mail]> @author Benjamin Eberlei <[e-mail]> @license MIT

Hierarchy

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

1 file declares its use of SymfonyFileLocator

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

File

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

Namespace

Doctrine\Common\Persistence\Mapping\Driver

class SymfonyFileLocator implements FileLocator {

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

  /**
   * A map of mapping directory path to namespace prefix used to expand class shortnames.
   *
   * @var array
   */
  protected $prefixes = array();

  /**
   * File extension that is searched for.
   *
   * @var string|null
   */
  protected $fileExtension;

  /**
   * Represents PHP namespace delimiters when looking for files
   *
   * @var string
   */
  private $nsSeparator;

  /**
   * Constructor.
   *
   * @param array       $prefixes
   * @param string|null $fileExtension
   * @param string      $nsSeparator String which would be used when converting FQCN to filename and vice versa. Should not be empty
   */
  public function __construct(array $prefixes, $fileExtension = null, $nsSeparator = '.') {
    $this
      ->addNamespacePrefixes($prefixes);
    $this->fileExtension = $fileExtension;
    if (empty($nsSeparator)) {
      throw new \InvalidArgumentException('Namespace separator should not be empty');
    }
    $this->nsSeparator = (string) $nsSeparator;
  }

  /**
   * Adds Namespace Prefixes.
   *
   * @param array $prefixes
   *
   * @return void
   */
  public function addNamespacePrefixes(array $prefixes) {
    $this->prefixes = array_merge($this->prefixes, $prefixes);
    $this->paths = array_merge($this->paths, array_keys($prefixes));
  }

  /**
   * Gets Namespace Prefixes.
   *
   * @return array
   */
  public function getNamespacePrefixes() {
    return $this->prefixes;
  }

  /**
   * {@inheritDoc}
   */
  public function getPaths() {
    return $this->paths;
  }

  /**
   * {@inheritDoc}
   */
  public function getFileExtension() {
    return $this->fileExtension;
  }

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

  /**
   * {@inheritDoc}
   */
  public function fileExists($className) {
    $defaultFileName = str_replace('\\', $this->nsSeparator, $className) . $this->fileExtension;
    foreach ($this->paths as $path) {
      if (!isset($this->prefixes[$path])) {

        // global namespace class
        if (is_file($path . DIRECTORY_SEPARATOR . $defaultFileName)) {
          return true;
        }
        continue;
      }
      $prefix = $this->prefixes[$path];
      if (0 !== strpos($className, $prefix . '\\')) {
        continue;
      }
      $filename = $path . '/' . strtr(substr($className, strlen($prefix) + 1), '\\', $this->nsSeparator) . $this->fileExtension;
      return is_file($filename);
    }
    return false;
  }

  /**
   * {@inheritDoc}
   */
  public function getAllClassNames($globalBasename = null) {
    $classes = array();
    if ($this->paths) {
      foreach ((array) $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!
          if (isset($this->prefixes[$path])) {

            // Calculate namespace suffix for given prefix as a relative path from basepath to file path
            $nsSuffix = strtr(substr(realpath($file
              ->getPath()), strlen(realpath($path))), $this->nsSeparator, '\\');
            $classes[] = $this->prefixes[$path] . $nsSuffix . '\\' . str_replace($this->nsSeparator, '\\', $fileName);
          }
          else {
            $classes[] = str_replace($this->nsSeparator, '\\', $fileName);
          }
        }
      }
    }
    return $classes;
  }

  /**
   * {@inheritDoc}
   */
  public function findMappingFile($className) {
    $defaultFileName = str_replace('\\', $this->nsSeparator, $className) . $this->fileExtension;
    foreach ($this->paths as $path) {
      if (!isset($this->prefixes[$path])) {
        if (is_file($path . DIRECTORY_SEPARATOR . $defaultFileName)) {
          return $path . DIRECTORY_SEPARATOR . $defaultFileName;
        }
        continue;
      }
      $prefix = $this->prefixes[$path];
      if (0 !== strpos($className, $prefix . '\\')) {
        continue;
      }
      $filename = $path . '/' . strtr(substr($className, strlen($prefix) + 1), '\\', $this->nsSeparator) . $this->fileExtension;
      if (is_file($filename)) {
        return $filename;
      }
      throw MappingException::mappingFileNotFound($className, $filename);
    }
    throw MappingException::mappingFileNotFound($className, substr($className, strrpos($className, '\\') + 1) . $this->fileExtension);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SymfonyFileLocator::$fileExtension	protected	property	File extension that is searched for.
SymfonyFileLocator::$nsSeparator	private	property	Represents PHP namespace delimiters when looking for files
SymfonyFileLocator::$paths	protected	property	The paths where to look for mapping files.
SymfonyFileLocator::$prefixes	protected	property	A map of mapping directory path to namespace prefix used to expand class shortnames.
SymfonyFileLocator::addNamespacePrefixes	public	function	Adds Namespace Prefixes.
SymfonyFileLocator::fileExists	public	function	Checks if a file can be found for this class name. Overrides FileLocator::fileExists
SymfonyFileLocator::findMappingFile	public	function	Locates mapping file for the given class name. Overrides FileLocator::findMappingFile
SymfonyFileLocator::getAllClassNames	public	function	Gets all class names that are found with this file locator. Overrides FileLocator::getAllClassNames
SymfonyFileLocator::getFileExtension	public	function	Gets the file extension that mapping files are suffixed with. Overrides FileLocator::getFileExtension
SymfonyFileLocator::getNamespacePrefixes	public	function	Gets Namespace Prefixes.
SymfonyFileLocator::getPaths	public	function	Gets all the paths that this file locator looks for mapping files. Overrides FileLocator::getPaths
SymfonyFileLocator::setFileExtension	public	function	Sets the file extension used to look for mapping files under.
SymfonyFileLocator::__construct	public	function	Constructor.