Driver.php 2.56 KB
Newer Older
1
<?php
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
/*
 * 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 LGPL. For more information, see
 * <http://www.doctrine-project.org>.
 */
19 20 21

namespace Doctrine\DBAL;

22 23 24 25 26 27
/**
 * Driver interface.
 * Interface that all DBAL drivers must implement.
 *
 * @since 2.0
 */
28
interface Driver
29 30 31 32 33 34 35 36
{
    /**
     * 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.
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 43 44
    /**
     * Gets the DatabasePlatform instance that provides all the metadata about
     * the platform this driver connects to.
     *
45
     * @return Doctrine\DBAL\Platforms\AbstractPlatform The database platform.
46 47
     */
    public function getDatabasePlatform();
48

49 50 51 52
    /**
     * Gets the SchemaManager that can be used to inspect and change the underlying
     * database schema of the platform this driver connects to.
     *
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 69 70
     *
     * @param  Doctrine\DBAL\Connection $conn
     * @return string $database
     */
71
    public function getDatabase(Connection $conn);
72
}