text: <?php
  /*
   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   *
   * This software consists of voluntary contributions made by many individuals
   * and is licensed under the MIT license. For more information, see
   * <http://www.doctrine-project.org>.
   */
  
  namespace Doctrine\Common\Persistence\Mapping\Driver;
  
  /**
   * 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>
   */
  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();
  }
  