[Sommaire] [Imprimer]

   1  <?php
   2  /*
   3   *  $Id: TokenReader.php 3076 2006-12-18 08:52:12Z fabien $
   4   *
   5   * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
   6   * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
   7   * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
   8   * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
   9   * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  10   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  11   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  12   * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  13   * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  14   * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  15   * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  16   *
  17   * This software consists of voluntary contributions made by many individuals
  18   * and is licensed under the LGPL. For more information please see
  19   * <http://phing.info>.
  20  */
  21  
  22  // include_once 'phing/system/io/Reader.php'; // really this is unrelated to Reader
  23  include_once 'phing/system/io/IOException.php';
  24  include_once 'phing/filters/ReplaceTokens.php'; // For class Token
  25  
  26  /**
  27   * Abstract class for TokenReaders.
  28   * 
  29   * @author    Manuel Holtgewe
  30   * @version   $Revision: 1.5 $
  31   * @package   phing.filters.util
  32   */
  33  abstract class TokenReader {
  34  
  35      /**
  36       * Reference to the Project the TokenReader is used in.
  37       * @var Project 
  38       */
  39      protected $project;
  40  
  41      /**
  42       * Constructor
  43       * @param   object  Reference to the project the TokenReader is used in.
  44       */
  45      function __construct(Project $project) {
  46          $this->project = $project;
  47      }
  48  
  49      /**
  50       * Utility function for logging
  51       */
  52      function log($level, $msg) {
  53          $this->project->log($level, $msg);
  54      }
  55  
  56      /**
  57       * Reads the next token from the Reader
  58       *
  59       * @throws IOException - On error
  60       * @return string
  61       */
  62      abstract public function readToken();
  63      
  64  }
  65  
  66  ?>