interface FileLocator in Plug 7

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

• interface \Doctrine\Common\Persistence\Mapping\Driver\FileLocator

File

lib/doctrine/common/lib/Doctrine/Common/Persistence/Mapping/Driver/FileLocator.php, line 31

Namespace

Doctrine\Common\Persistence\Mapping\Driver

interface FileLocator {

  /**
   * Locates mapping file for the given class name.
   *
   * @param string $className
   *
   * @return string
   */
  public function findMappingFile($className);

  /**
   * Gets all class names that are found with this file locator.
   *
   * @param string $globalBasename Passed to allow excluding the basename.
   *
   * @return array
   */
  public function getAllClassNames($globalBasename);

  /**
   * Checks if a file can be found for this class name.
   *
   * @param string $className
   *
   * @return bool
   */
  public function fileExists($className);

  /**
   * Gets all the paths that this file locator looks for mapping files.
   *
   * @return array
   */
  public function getPaths();

  /**
   * Gets the file extension that mapping files are suffixed with.
   *
   * @return string
   */
  public function getFileExtension();

}

Members

Name	Modifiers	Type	Description	Overrides
FileLocator::fileExists	public	function	Checks if a file can be found for this class name.	2
FileLocator::findMappingFile	public	function	Locates mapping file for the given class name.	2
FileLocator::getAllClassNames	public	function	Gets all class names that are found with this file locator.	2
FileLocator::getFileExtension	public	function	Gets the file extension that mapping files are suffixed with.	2
FileLocator::getPaths	public	function	Gets all the paths that this file locator looks for mapping files.	2