interface ClassMetadataFactory

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>

Hierarchy

Expanded class hierarchy of ClassMetadataFactory

All classes that implement ClassMetadataFactory

File

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

Namespace

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

}

Members

Namesort descending Modifiers Type Description Overrides
ClassMetadataFactory::getAllMetadata function Forces the factory to load the metadata of all classes known to the underlying mapping driver. 1
ClassMetadataFactory::getMetadataFor function Gets the class metadata descriptor for a class. 1
ClassMetadataFactory::hasMetadataFor function Checks whether the factory has the metadata for a class loaded already. 1
ClassMetadataFactory::isTransient function 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. 1
ClassMetadataFactory::setMetadataFor function Sets the metadata descriptor for a specific class. 1