Identifier.php 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  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. /**
  21. * An abstraction class for an asset identifier.
  22. *
  23. * Wraps identifier names like column names in indexes / foreign keys
  24. * in an abstract class for proper quotation capabilities.
  25. *
  26. * @author Steve Müller <st.mueller@dzh-online.de>
  27. * @link www.doctrine-project.org
  28. * @since 2.4
  29. */
  30. class Identifier extends AbstractAsset
  31. {
  32. /**
  33. * Constructor.
  34. *
  35. * @param string $identifier Identifier name to wrap.
  36. * @param bool $quote Whether to force quoting the given identifier.
  37. */
  38. public function __construct($identifier, $quote = false)
  39. {
  40. $this->_setName($identifier);
  41. if ($quote && ! $this->_quoted) {
  42. $this->_setName('"' . $this->getName() . '"');
  43. }
  44. }
  45. }