Driver.php 2.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  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 MIT license. For more information, see
  17. * <http://www.doctrine-project.org>.
  18. */
  19. namespace Doctrine\DBAL;
  20. /**
  21. * Driver interface.
  22. * Interface that all DBAL drivers must implement.
  23. *
  24. * @since 2.0
  25. */
  26. interface Driver
  27. {
  28. /**
  29. * Attempts to create a connection with the database.
  30. *
  31. * @param array $params All connection parameters passed by the user.
  32. * @param string|null $username The username to use when connecting.
  33. * @param string|null $password The password to use when connecting.
  34. * @param array $driverOptions The driver options to use when connecting.
  35. *
  36. * @return \Doctrine\DBAL\Driver\Connection The database connection.
  37. */
  38. public function connect(array $params, $username = null, $password = null, array $driverOptions = array());
  39. /**
  40. * Gets the DatabasePlatform instance that provides all the metadata about
  41. * the platform this driver connects to.
  42. *
  43. * @return \Doctrine\DBAL\Platforms\AbstractPlatform The database platform.
  44. */
  45. public function getDatabasePlatform();
  46. /**
  47. * Gets the SchemaManager that can be used to inspect and change the underlying
  48. * database schema of the platform this driver connects to.
  49. *
  50. * @param \Doctrine\DBAL\Connection $conn
  51. *
  52. * @return \Doctrine\DBAL\Schema\AbstractSchemaManager
  53. */
  54. public function getSchemaManager(Connection $conn);
  55. /**
  56. * Gets the name of the driver.
  57. *
  58. * @return string The name of the driver.
  59. */
  60. public function getName();
  61. /**
  62. * Gets the name of the database connected to for this driver.
  63. *
  64. * @param \Doctrine\DBAL\Connection $conn
  65. *
  66. * @return string The name of the database.
  67. */
  68. public function getDatabase(Connection $conn);
  69. }