Home | Classes | Modules | Annotated | Functions | Files

SQLStatementExtractor.php

Go to the documentation of this file.

<?php
/*
 *  $Id: SQLStatementExtractor.php,v 1.3 2004/05/23 11:05:27 micha Exp $
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://creole.phpdb.org>.
 */

class SQLStatementExtractor
{
  var $delimiter = ';';

  function extractFile($filename)
  {
    $buffer = file_get_contents($filename);
    if ($buffer === false) {
      return new Exception(CREOLE_ERROR, "Unable to read file: " . $filename);
    }
    return SQLStatementExtractor::extractStatements(SQLStatementExtractor::getLines($buffer));
  }

  function & extract(&$buffer)
  {
    return SQLStatementExtractor::extractStatements(SQLStatementExtractor::getLines($buffer));
  }

  function & extractStatements(&$lines)
  {
    $self =& SQLStatementExtractor::getInstance();
    $statements = array();
    $sql = "";

    foreach($lines as $line)
    {
      $line = trim($line);

      if (SQLStatementExtractor::startsWith("//", $line) ||
        SQLStatementExtractor::startsWith("--", $line) ||
        SQLStatementExtractor::startsWith("#", $line)) {
        continue;
      }

      if (strlen($line) > 4 && strtoupper(substr($line,0, 4)) == "REM ") {
        continue;
      }

      $sql .= " " . $line;
      $sql = trim($sql);

      // SQL defines "--" as a comment to EOL
      // and in Oracle it may contain a hint
      // so we cannot just remove it, instead we must end it
      if (strpos($line, "--") !== false) {
          $sql .= "\n";
      }

      if (SQLStatementExtractor::endsWith($self->delimiter, $sql)) {
          $statements[] = SQLStatementExtractor::substring($sql, 0, strlen($sql) - strlen($self->delimiter));
          $sql = "";
      }
    }

    return $statements;
  }

  //
  // Some string helper functions
  //

  function startsWith($check, $string)
  {
    if ($check === "" || $check === $string) {
      return true;
    } else {
      return (strpos($string, $check) === 0) ? true : false;
    }
  }

  function endsWith($check, $string)
  {
    if ($check === "" || $check === $string) {
      return true;
    } else {
      return (strpos(strrev($string), strrev($check)) === 0) ? true : false;
    }
  }

  function substring($string, $startpos, $endpos = -1)
  {
    $len    = strlen($string);
    $endpos = (int) (($endpos === -1) ? $len-1 : $endpos);
    if ($startpos > $len-1 || $startpos < 0) {
        trigger_error("substring(), Startindex out of bounds must be 0<n<$len", E_USER_ERROR);
    }
    if ($endpos > $len-1 || $endpos < $startpos) {
        trigger_error("substring(), Endindex out of bounds must be $startpos<n<".($len-1), E_USER_ERROR);
    }
    if ($startpos === $endpos) {
        return (string) $string{$startpos};
    } else {
        $len = $endpos-$startpos;
    }
    return substr($string, $startpos, $len+1);
  }

  function & getLines($buffer)
  {
    $lines = preg_split("/\r?\n|\r/", $buffer);
    return $lines;
  }

  /*
  * @private
  */
  function & getInstance()
  {
    static $instance;

    if ($instance === null)
    {
      $instance = new SQLStatementExtractor();
    }

    return $instance;
  }

}

---

This file is part of the Creole[php4] library.