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 <fabien@symfony.com> @author Benjamin Eberlei <kontakt@beberlei.de> @license MIT
Expanded class hierarchy of SymfonyFileLocator
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
*/
protected $fileExtension;
/**
* Constructor
*
* @param array $prefixes
* @param string|null $fileExtension
*/
public function __construct(array $prefixes, $fileExtension = null) {
$this
->addNamespacePrefixes($prefixes);
$this->fileExtension = $fileExtension;
}
/**
* Add Namespace Prefixes
*
* @param array $prefixes
*/
public function addNamespacePrefixes(array $prefixes) {
$this->prefixes = array_merge($this->prefixes, $prefixes);
$this->paths = array_merge($this->paths, array_keys($prefixes));
}
/**
* Get Namespace Prefixes
*
* @return array
*/
public function getNamespacePrefixes() {
return $this->prefixes;
}
/**
* {@inheritDoc}
*/
public function getPaths() {
return $this->paths;
}
/**
* {@inheritDoc}
*/
public function getFileExtension() {
return $this->fileExtension;
}
/**
* Set 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('\\', '.', $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->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])) {
$classes[] = $this->prefixes[$path] . '\\' . str_replace('.', '\\', $fileName);
}
else {
$classes[] = str_replace('.', '\\', $fileName);
}
}
}
}
return $classes;
}
/**
* {@inheritDoc}
*/
public function findMappingFile($className) {
$defaultFileName = str_replace('\\', '.', $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->fileExtension;
if (is_file($filename)) {
return $filename;
}
throw MappingException::mappingFileNotFound($className, $filename);
}
throw MappingException::mappingFileNotFound($className, substr($className, strrpos($className, '\\') + 1) . $this->fileExtension);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
SymfonyFileLocator:: |
public | function | Constructor | |
SymfonyFileLocator:: |
public | function | Set the file extension used to look for mapping files under | |
SymfonyFileLocator:: |
public | function |
Get all the paths that this file locator looks for mapping files. Overrides FileLocator:: |
|
SymfonyFileLocator:: |
public | function | Get Namespace Prefixes | |
SymfonyFileLocator:: |
public | function |
Get the file extension that mapping files are suffixed with. Overrides FileLocator:: |
|
SymfonyFileLocator:: |
public | function |
Get all class names that are found with this file locator. Overrides FileLocator:: |
|
SymfonyFileLocator:: |
public | function |
Locate mapping file for the given class name. Overrides FileLocator:: |
|
SymfonyFileLocator:: |
public | function |
Check if a file can be found for this class name. Overrides FileLocator:: |
|
SymfonyFileLocator:: |
public | function | Add Namespace Prefixes | |
SymfonyFileLocator:: |
protected | property | A map of mapping directory path to namespace prefix used to expand class shortnames. | |
SymfonyFileLocator:: |
protected | property | The paths where to look for mapping files. | |
SymfonyFileLocator:: |
protected | property | File extension that is searched for. |