vendor/doctrine/dbal/lib/Doctrine/DBAL/Platforms/Keywords/KeywordList.php

   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
  20
  21 namespace Doctrine\DBAL\Platforms\Keywords;
  22
  23 /**
  24  * Abstract interface for a SQL reserved keyword dictionary.
  25  *
  26  * @license     http://www.opensource.org/licenses/lgpl-license.php LGPL
  27  * @link        www.doctrine-project.com
  28  * @since       2.0
  29  * @author      Benjamin Eberlei <kontakt@beberlei.de>
  30  */
  31 abstract class KeywordList
  32 {
  33     private $keywords = null;
  34
  35     /**
  36      * Check if the given word is a keyword of this dialect/vendor platform.
  37      *
  38      * @param  string $word
  39      * @return bool
  40      */
  41     public function isKeyword($word)
  42     {
  43         if ($this->keywords === null) {
  44             $this->initializeKeywords();
  45         }
  46
  47         return isset($this->keywords[strtoupper($word)]);
  48     }
  49
  50     protected function initializeKeywords()
  51     {
  52         $this->keywords = array_flip(array_map('strtoupper', $this->getKeywords()));
  53     }
  54
  55     abstract protected function getKeywords();
  56
  57     /**
  58      * Name of this keyword list.
  59      *
  60      * @return string
  61      */
  62     abstract public function getName();
  63 }