ExceptionConverterDriver.php 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  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 that is capable of converting DBAL driver exceptions into standardized DBAL driver exceptions.
  22. *
  23. * @author Benjamin Eberlei <kontakt@beberlei.de>
  24. * @author Steve Müller <st.mueller@dzh-online.de>
  25. * @link www.doctrine-project.org
  26. * @since 2.5
  27. */
  28. interface ExceptionConverterDriver
  29. {
  30. /**
  31. * Converts a given DBAL driver exception into a standardized DBAL driver exception.
  32. *
  33. * It evaluates the vendor specific error code and SQLSTATE and transforms
  34. * it into a unified {@link Doctrine\DBAL\Exception\DriverException} subclass.
  35. *
  36. * @param string $message The DBAL exception message to use.
  37. * @param \Doctrine\DBAL\Driver\DriverException $exception The DBAL driver exception to convert.
  38. *
  39. * @return \Doctrine\DBAL\Exception\DriverException An instance of one of the DriverException subclasses.
  40. */
  41. public function convertException($message, DriverException $exception);
  42. }