You are here

interface MappingDriver in Plug 7

Contract for metadata drivers.

@since 2.2 @author Jonathan H. Wage <jonwage@gmail.com>

Hierarchy

  • interface \Doctrine\Common\Persistence\Mapping\Driver\MappingDriver

Expanded class hierarchy of MappingDriver

All classes that implement MappingDriver

File

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

Namespace

Doctrine\Common\Persistence\Mapping\Driver
View source
interface MappingDriver {

  /**
   * Loads the metadata for the specified class into the provided container.
   *
   * @param string        $className
   * @param ClassMetadata $metadata
   *
   * @return void
   */
  public function loadMetadataForClass($className, ClassMetadata $metadata);

  /**
   * Gets the names of all mapped classes known to this driver.
   *
   * @return array The names of all mapped classes known to this driver.
   */
  public function getAllClassNames();

  /**
   * Returns whether the class with the specified name should have its metadata loaded.
   * This is only the case if it is either mapped as an Entity or a MappedSuperclass.
   *
   * @param string $className
   *
   * @return boolean
   */
  public function isTransient($className);

}

Members

Namesort descending Modifiers Type Description Overrides
MappingDriver::getAllClassNames public function Gets the names of all mapped classes known to this driver. 4
MappingDriver::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 as an Entity or a MappedSuperclass. 4
MappingDriver::loadMetadataForClass public function Loads the metadata for the specified class into the provided container. 5