Constraint.php 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  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\Schema;
  20. use Doctrine\DBAL\Platforms\AbstractPlatform;
  21. /**
  22. * Marker interface for contraints.
  23. *
  24. * @link www.doctrine-project.org
  25. * @since 2.0
  26. * @author Benjamin Eberlei <kontakt@beberlei.de>
  27. */
  28. interface Constraint
  29. {
  30. /**
  31. * @return string
  32. */
  33. public function getName();
  34. /**
  35. * @param \Doctrine\DBAL\Platforms\AbstractPlatform $platform
  36. *
  37. * @return string
  38. */
  39. public function getQuotedName(AbstractPlatform $platform);
  40. /**
  41. * Returns the names of the referencing table columns
  42. * the constraint is associated with.
  43. *
  44. * @return array
  45. */
  46. public function getColumns();
  47. /**
  48. * Returns the quoted representation of the column names
  49. * the constraint is associated with.
  50. *
  51. * But only if they were defined with one or a column name
  52. * is a keyword reserved by the platform.
  53. * Otherwise the plain unquoted value as inserted is returned.
  54. *
  55. * @param \Doctrine\DBAL\Platforms\AbstractPlatform $platform The platform to use for quotation.
  56. *
  57. * @return array
  58. */
  59. public function getQuotedColumns(AbstractPlatform $platform);
  60. }