interface FileLocator (View source)

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

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

Methods

string
findMappingFile(string $className)

Locate mapping file for the given class name.

array
getAllClassNames(string $globalBasename)

Get all class names that are found with this file locator.

bool
fileExists($className)

Check if a file can be found for this class name.

array
getPaths()

Get all the paths that this file locator looks for mapping files.

string
getFileExtension()

Get the file extension that mapping files are suffixed with.

Details

string findMappingFile(string $className)

Locate mapping file for the given class name.

Parameters

string $className

Return Value

string

array getAllClassNames(string $globalBasename)

Get all class names that are found with this file locator.

Parameters

string $globalBasename Passed to allow excluding the basename

Return Value

array

bool fileExists($className)

Check if a file can be found for this class name.

Parameters

$className

Return Value

bool

array getPaths()

Get all the paths that this file locator looks for mapping files.

Return Value

array

string getFileExtension()

Get the file extension that mapping files are suffixed with.

Return Value

string