MappingDriver.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 MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */
namespace Doctrine\Common\Persistence\Mapping\Driver;

use Doctrine\Common\Persistence\Mapping\ClassMetadata;

/**
 * Contract for metadata drivers.
 *
 * @since 2.2
 * @author Jonathan H. Wage <jonwage@gmail.com>
 */
interface MappingDriver {

  /**
   * Loads the metadata for the specified class into the provided container.
   *
   * @param string $className
   * @param ClassMetadata $metadata
   */
  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.
   */
  function getAllClassNames();

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

}