src/phpsqllint/Renderer.php

   1 <?php
   2 /**
   3  * Part of php-sqllint
   4  *
   5  * PHP version 5
   6  *
   7  * @category Tools
   8  * @package  PHP-SQLlint
   9  * @author   Christian Weiske <cweiske@cweiske.de>
  10  * @license  http://www.gnu.org/licenses/agpl.html GNU AGPL v3
  11  * @link     http://cweiske.de/php-sqllint.htm
  12  */
  13 namespace phpsqllint;
  14
  15 /**
  16  * What every renderer has to implement
  17  *
  18  * @category Tools
  19  * @package  PHP-SQLlint
  20  * @author   Christian Weiske <cweiske@cweiske.de>
  21  * @license  http://www.gnu.org/licenses/agpl.html GNU AGPL v3
  22  * @link     http://www.emacswiki.org/emacs/CreatingYourOwnCompileErrorRegexp
  23  */
  24 interface Renderer
  25 {
  26     /**
  27      * Begin syntax check output rendering
  28      *
  29      * @param string $filename Path to the SQL file
  30      *
  31      * @return void
  32      */
  33     public function startRendering($filename);
  34
  35     /**
  36      * Output errors in GNU style; see emacs compilation.txt
  37      *
  38      * @param string  $msg   Error message
  39      * @param string  $token Character which caused the error
  40      * @param integer $line  Line at which the error occured
  41      * @param integer $col   Column at which the error occured
  42      *
  43      * @return void
  44      */
  45     public function displayError($msg, $token, $line, $col);
  46
  47     /**
  48      * Finish syntax check output rendering; no syntax errors found
  49      *
  50      * @return void
  51      */
  52     public function finishOk();
  53 }
  54 ?>