Locate 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 <kontakt@beberlei.de> @author Johannes M. Schmitt <schmittjoh@gmail.com>
Expanded class hierarchy of FileLocator
All classes that implement FileLocator
interface FileLocator {
/**
* Locate mapping file for the given class name.
*
* @param string $className
* @return string
*/
function findMappingFile($className);
/**
* Get all class names that are found with this file locator.
*
* @param string $globalBasename Passed to allow excluding the basename
* @return array
*/
function getAllClassNames($globalBasename);
/**
* Check if a file can be found for this class name.
*
* @param string $className
*
* @return bool
*/
function fileExists($className);
/**
* Get all the paths that this file locator looks for mapping files.
*
* @return array
*/
function getPaths();
/**
* Get the file extension that mapping files are suffixed with.
*
* @return string
*/
function getFileExtension();
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
FileLocator:: |
function | Check if a file can be found for this class name. | 2 | |
FileLocator:: |
function | Locate mapping file for the given class name. | 2 | |
FileLocator:: |
function | Get all class names that are found with this file locator. | 2 | |
FileLocator:: |
function | Get the file extension that mapping files are suffixed with. | 2 | |
FileLocator:: |
function | Get all the paths that this file locator looks for mapping files. | 2 |