70 lines
2.2 KiB
PHP
70 lines
2.2 KiB
PHP
<?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 LGPL. For more information, see
|
|
* <http://www.doctrine-project.org>.
|
|
*/
|
|
|
|
namespace Doctrine\Common\Persistence\Mapping\Driver;
|
|
|
|
/**
|
|
* Locate the file that contains the metadata information for a given class name.
|
|
*
|
|
* This behavior is inpependent 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
|
|
{
|
|
/**
|
|
* 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.
|
|
*
|
|
* @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();
|
|
}
|