interface FileLocator

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>

Hierarchy

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

Expanded class hierarchy of FileLocator

All classes that implement FileLocator

File

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

Namespace

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

}

Members

Namesort descending Modifiers Type Description Overrides
FileLocator::fileExists function Check if a file can be found for this class name. 2
FileLocator::findMappingFile function Locate mapping file for the given class name. 2
FileLocator::getAllClassNames function Get all class names that are found with this file locator. 2
FileLocator::getFileExtension function Get the file extension that mapping files are suffixed with. 2
FileLocator::getPaths function Get all the paths that this file locator looks for mapping files. 2