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

   1 <?php
   2 /*
   3  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   4  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   5  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   6  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   7  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
   8  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
   9  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  10  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  11  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  12  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  13  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14  *
  15  * This software consists of voluntary contributions made by many individuals
  16  * and is licensed under the MIT license. For more information, see
  17  * <http://www.doctrine-project.org>.
  18 */
  19
  20 namespace Doctrine\Common\Persistence\Mapping\Driver;
  21
  22 /**
  23  * Locate the file that contains the metadata information for a given class name.
  24  *
  25  * This behavior is independent of the actual content of the file. It just detects
  26  * the file which is responsible for the given class name.
  27  *
  28  * @author Benjamin Eberlei <kontakt@beberlei.de>
  29  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  30  */
  31 interface FileLocator
  32 {
  33     /**
  34      * Locate mapping file for the given class name.
  35      *
  36      * @param string $className
  37      * @return string
  38      */
  39     function findMappingFile($className);
  40
  41     /**
  42      * Get all class names that are found with this file locator.
  43      *
  44      * @param string $globalBasename Passed to allow excluding the basename
  45      * @return array
  46      */
  47     function getAllClassNames($globalBasename);
  48
  49     /**
  50      * Check if a file can be found for this class name.
  51      *
  52      * @param string $className
  53      *
  54      * @return bool
  55      */
  56     function fileExists($className);
  57
  58     /**
  59      * Get all the paths that this file locator looks for mapping files.
  60      *
  61      * @return array
  62      */
  63     function getPaths();
  64
  65     /**
  66      * Get the file extension that mapping files are suffixed with.
  67      *
  68      * @return string
  69      */
  70     function getFileExtension();
  71 }