<?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\DBAL;
  
  /**
   * Driver interface.
   * Interface that all DBAL drivers must implement.
   *
   * @since 2.0
   */
  interface Driver
  {
      /**
       * Attempts to create a connection with the database.
       *
       * @param array $params All connection parameters passed by the user.
       * @param string $username The username to use when connecting.
       * @param string $password The password to use when connecting.
       * @param array $driverOptions The driver options to use when connecting.
       * @return \Doctrine\DBAL\Driver\Connection The database connection.
       */
      public function connect(array $params, $username = null, $password = null, array $driverOptions = array());
  
      /**
       * Gets the DatabasePlatform instance that provides all the metadata about
       * the platform this driver connects to.
       *
       * @return \Doctrine\DBAL\Platforms\AbstractPlatform The database platform.
       */
      public function getDatabasePlatform();
  
      /**
       * Gets the SchemaManager that can be used to inspect and change the underlying
       * database schema of the platform this driver connects to.
       *
       * @param  \Doctrine\DBAL\Connection $conn
       * @return \Doctrine\DBAL\Schema\AbstractSchemaManager
       */
      public function getSchemaManager(Connection $conn);
  
      /**
       * Gets the name of the driver.
       *
       * @return string The name of the driver.
       */
      public function getName();
  
      /**
       * Get the name of the database connected to for this driver.
       *
       * @param  \Doctrine\DBAL\Connection $conn
       * @return string $database
       */
      public function getDatabase(Connection $conn);
  }