Connection.php 3.08 KB
Newer Older
romanb's avatar
romanb committed
1
<?php
2 3 4 5 6 7 8 9 10 11 12 13 14 15
/*
 * 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
Benjamin Eberlei's avatar
Benjamin Eberlei committed
16
 * and is licensed under the MIT license. For more information, see
17 18
 * <http://www.doctrine-project.org>.
 */
romanb's avatar
romanb committed
19

20 21
namespace Doctrine\DBAL\Driver;

22 23
use Doctrine\DBAL\ParameterType;

romanb's avatar
romanb committed
24 25
/**
 * Connection interface.
26
 * Driver connections must implement this interface.
romanb's avatar
romanb committed
27
 *
28
 * This resembles (a subset of) the PDO interface.
29
 *
romanb's avatar
romanb committed
30 31
 * @since 2.0
 */
32
interface Connection
romanb's avatar
romanb committed
33
{
Benjamin Morel's avatar
Benjamin Morel committed
34 35 36 37 38
    /**
     * Prepares a statement for execution and returns a Statement object.
     *
     * @param string $prepareString
     *
39
     * @return Statement
Benjamin Morel's avatar
Benjamin Morel committed
40
     */
41
    public function prepare($prepareString);
Benjamin Morel's avatar
Benjamin Morel committed
42 43 44 45 46 47

    /**
     * Executes an SQL statement, returning a result set as a Statement object.
     *
     * @return \Doctrine\DBAL\Driver\Statement
     */
48
    public function query();
Benjamin Morel's avatar
Benjamin Morel committed
49 50 51 52

    /**
     * Quotes a string for use in a query.
     *
53 54
     * @param mixed $input
     * @param int   $type
Benjamin Morel's avatar
Benjamin Morel committed
55
     *
56
     * @return mixed
Benjamin Morel's avatar
Benjamin Morel committed
57
     */
58
    public function quote($input, $type = ParameterType::STRING);
Benjamin Morel's avatar
Benjamin Morel committed
59 60 61 62 63 64

    /**
     * Executes an SQL statement and return the number of affected rows.
     *
     * @param string $statement
     *
65
     * @return int
Benjamin Morel's avatar
Benjamin Morel committed
66
     */
67
    public function exec($statement);
Benjamin Morel's avatar
Benjamin Morel committed
68 69 70 71 72 73 74 75

    /**
     * Returns the ID of the last inserted row or sequence value.
     *
     * @param string|null $name
     *
     * @return string
     */
76
    public function lastInsertId($name = null);
Benjamin Morel's avatar
Benjamin Morel committed
77 78 79 80

    /**
     * Initiates a transaction.
     *
81
     * @return bool TRUE on success or FALSE on failure.
Benjamin Morel's avatar
Benjamin Morel committed
82
     */
83
    public function beginTransaction();
Benjamin Morel's avatar
Benjamin Morel committed
84 85 86 87

    /**
     * Commits a transaction.
     *
88
     * @return bool TRUE on success or FALSE on failure.
Benjamin Morel's avatar
Benjamin Morel committed
89
     */
90
    public function commit();
Benjamin Morel's avatar
Benjamin Morel committed
91 92 93 94

    /**
     * Rolls back the current transaction, as initiated by beginTransaction().
     *
95
     * @return bool TRUE on success or FALSE on failure.
Benjamin Morel's avatar
Benjamin Morel committed
96
     */
97
    public function rollBack();
Benjamin Morel's avatar
Benjamin Morel committed
98 99 100 101 102 103

    /**
     * Returns the error code associated with the last operation on the database handle.
     *
     * @return string|null The error code, or null if no operation has been run on the database handle.
     */
104
    public function errorCode();
Benjamin Morel's avatar
Benjamin Morel committed
105 106 107 108 109 110

    /**
     * Returns extended error information associated with the last operation on the database handle.
     *
     * @return array
     */
111
    public function errorInfo();
Benjamin Eberlei's avatar
Benjamin Eberlei committed
112
}