1 <?php

     2 /*

     3  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS

     4  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT

     5  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR

     6  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT

     7  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,

     8  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT

     9  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,

    10  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY

    11  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

    12  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE

    13  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

    14  *

    15  * This software consists of voluntary contributions made by many individuals

    16  * and is licensed under the LGPL. For more information, see

    17  * <http://www.doctrine-project.org>.

    18  */

    19 

    20 namespace Doctrine\DBAL;

    21 

    22 /**

    23  * Driver interface.

    24  * Interface that all DBAL drivers must implement.

    25  *

    26  * @since 2.0

    27  */

    28 interface Driver

    29 {

    30     /**

    31      * Attempts to create a connection with the database.

    32      *

    33      * @param array $params All connection parameters passed by the user.

    34      * @param string $username The username to use when connecting.

    35      * @param string $password The password to use when connecting.

    36      * @param array $driverOptions The driver options to use when connecting.

    37      * @return Doctrine\DBAL\Driver\Connection The database connection.

    38      */

    39     public function connect(array $params, $username = null, $password = null, array $driverOptions = array());

    40 

    41     /**

    42      * Gets the DatabasePlatform instance that provides all the metadata about

    43      * the platform this driver connects to.

    44      *

    45      * @return Doctrine\DBAL\Platforms\AbstractPlatform The database platform.

    46      */

    47     public function getDatabasePlatform();

    48 

    49     /**

    50      * Gets the SchemaManager that can be used to inspect and change the underlying

    51      * database schema of the platform this driver connects to.

    52      *

    53      * @param  Doctrine\DBAL\Connection $conn

    54      * @return Doctrine\DBAL\SchemaManager

    55      */

    56     public function getSchemaManager(Connection $conn);

    57 

    58     /**

    59      * Gets the name of the driver.

    60      *

    61      * @return string The name of the driver.

    62      */

    63     public function getName();

    64 

    65     /**

    66      * Get the name of the database connected to for this driver.

    67      *

    68      * @param  Doctrine\DBAL\Connection $conn

    69      * @return string $database

    70      */

    71     public function getDatabase(Connection $conn);

    72 }