You are here

interface FileLocator in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 vendor/doctrine/common/lib/Doctrine/Common/Persistence/Mapping/Driver/FileLocator.php \Doctrine\Common\Persistence\Mapping\Driver\FileLocator

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 <kontakt@beberlei.de> @author Johannes M. Schmitt <schmittjoh@gmail.com>

Hierarchy

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

Expanded class hierarchy of FileLocator

All classes that implement FileLocator

File

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

Namespace

Doctrine\Common\Persistence\Mapping\Driver
View source
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

Namesort descending 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