interface ClassMetadataFactory in Plug 7

Contract for a Doctrine persistence layer ClassMetadata class to implement.

@link www.doctrine-project.org @since 2.1 @author Benjamin Eberlei <[e-mail]> @author Jonathan Wage <[e-mail]>

Hierarchy

• interface \Doctrine\Common\Persistence\Mapping\ClassMetadataFactory

1 file declares its use of ClassMetadataFactory

AbstractProxyFactory.php in lib/doctrine/common/lib/Doctrine/Common/Proxy/AbstractProxyFactory.php

File

lib/doctrine/common/lib/Doctrine/Common/Persistence/Mapping/ClassMetadataFactory.php, line 30

Namespace

Doctrine\Common\Persistence\Mapping

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.
   */
  public function getAllMetadata();

  /**
   * Gets the class metadata descriptor for a class.
   *
   * @param string $className The name of the class.
   *
   * @return ClassMetadata
   */
  public 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.
   */
  public function hasMetadataFor($className);

  /**
   * Sets the metadata descriptor for a specific class.
   *
   * @param string $className
   *
   * @param ClassMetadata $class
   */
  public function setMetadataFor($className, $class);

  /**
   * Returns 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
   */
  public function isTransient($className);

}

Members

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