DriverException.php 1.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  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\Driver;
  20. /**
  21. * Contract for a driver exception.
  22. *
  23. * Driver exceptions provide the SQLSTATE of the driver
  24. * and the driver specific error code at the time the error occurred.
  25. *
  26. * @author Steve Müller <st.mueller@dzh-online.de>
  27. * @link www.doctrine-project.org
  28. * @since 2.5
  29. */
  30. interface DriverException
  31. {
  32. /**
  33. * Returns the driver specific error code if available.
  34. *
  35. * Returns null if no driver specific error code is available
  36. * for the error raised by the driver.
  37. *
  38. * @return integer|string|null
  39. */
  40. public function getErrorCode();
  41. /**
  42. * Returns the driver error message.
  43. *
  44. * @return string
  45. */
  46. public function getMessage();
  47. /**
  48. * Returns the SQLSTATE the driver was in at the time the error occurred.
  49. *
  50. * Returns null if the driver does not provide a SQLSTATE for the error occurred.
  51. *
  52. * @return string|null
  53. */
  54. public function getSQLState();
  55. }