75 lines
2.5 KiB
PHP
75 lines
2.5 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;
|
|
|
|
/**
|
|
* Contract for a Doctrine persistence layer ClassMetadata class to implement.
|
|
*
|
|
* @license http://www.opensource.org/licenses/lgpl-license.php LGPL
|
|
* @link www.doctrine-project.org
|
|
* @since 2.1
|
|
* @author Benjamin Eberlei <kontakt@beberlei.de>
|
|
* @author Jonathan Wage <jonwage@gmail.com>
|
|
*/
|
|
interface ClassMetadataFactory
|
|
{
|
|
/**
|
|
* Forces the factory to load the metadata of all classes known to the underlying
|
|
* mapping driver.
|
|
*
|
|
* @return array The ClassMetadata instances of all mapped classes.
|
|
*/
|
|
function getAllMetadata();
|
|
|
|
/**
|
|
* Gets the class metadata descriptor for a class.
|
|
*
|
|
* @param string $className The name of the class.
|
|
* @return ClassMetadata
|
|
*/
|
|
function getMetadataFor($className);
|
|
|
|
/**
|
|
* Checks whether the factory has the metadata for a class loaded already.
|
|
*
|
|
* @param string $className
|
|
* @return boolean TRUE if the metadata of the class in question is already loaded, FALSE otherwise.
|
|
*/
|
|
function hasMetadataFor($className);
|
|
|
|
/**
|
|
* Sets the metadata descriptor for a specific class.
|
|
*
|
|
* @param string $className
|
|
* @param ClassMetadata $class
|
|
*/
|
|
function setMetadataFor($className, $class);
|
|
|
|
/**
|
|
* Whether the class with the specified name should have its metadata loaded.
|
|
* This is only the case if it is either mapped directly or as a
|
|
* MappedSuperclass.
|
|
*
|
|
* @param string $className
|
|
* @return boolean
|
|
*/
|
|
function isTransient($className);
|
|
}
|