VersionAwarePlatformDriver.php 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647
  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. * Contract for a driver that is able to create platform instances by version.
  22. *
  23. * Doctrine uses different platform classes for different vendor versions to
  24. * support the correct features and SQL syntax of each version.
  25. * This interface should be implemented by drivers that are capable to do this
  26. * distinction.
  27. *
  28. * @author Steve Müller <st.mueller@dzh-online.de>
  29. * @link www.doctrine-project.org
  30. * @since 2.5
  31. */
  32. interface VersionAwarePlatformDriver
  33. {
  34. /**
  35. * Factory method for creating the appropriate platform instance for the given version.
  36. *
  37. * @param string $version The platform/server version string to evaluate. This should be given in the notation
  38. * the underlying database vendor uses.
  39. *
  40. * @return \Doctrine\DBAL\Platforms\AbstractPlatform
  41. *
  42. * @throws DBALException if the given version string could not be evaluated.
  43. */
  44. public function createDatabasePlatformForVersion($version);
  45. }