[Sommaire] [Imprimer]

   1  <?php
   2  /*
   3   *  $Id: Reader.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  /**
  23   * Abstract class for reading character streams.
  24   * @author Hans Lellelid <hans@xmpl.org>
  25   * @author Yannick Lecaillez <yl@seasonfive.com>
  26   * @version $Revision: 1.5 $
  27   * @package phing.system.io
  28   */
  29  abstract class Reader {
  30  
  31      /**
  32       * Read data from source.
  33       * If length is specified, then only that number of chars is read,
  34       * otherwise stream is read until EOF.
  35       * @param int $len
  36       */
  37      abstract public function read($len = null);
  38              
  39      /**
  40       * Close stream.
  41       */
  42      abstract public function close();
  43      
  44      /**
  45       * Open stream for reading.
  46       */
  47      abstract public function open();
  48      
  49      /**
  50       * Returns the filename, url, etc. that is being read from.
  51       * This is critical for, e.g., ExpatParser's ability to know
  52       * the filename that is throwing an ExpatParserException, etc.
  53       * @return string
  54       */
  55      abstract function getResource();
  56  
  57      /**
  58       * Move stream position relative to current pos.
  59       * @param int $n
  60       */
  61      public function skip($n) {}
  62      
  63      /**
  64       * Reset the current position in stream to beginning or last mark (if supported).
  65       */    
  66      public function reset() {}
  67          
  68      /**
  69       * If supported, places a "marker" (like a bookmark) at current stream position.
  70       * A subsequent call to reset() will move stream position back
  71       * to last marker (if supported).
  72       */    
  73      public function mark() {}
  74  
  75      /**
  76       * Whether marking is supported.
  77       * @return boolean
  78       */
  79      public function markSupported() {}
  80      
  81      /**
  82       * Is stream ready for reading.
  83       * @return boolean
  84       */
  85      public function ready() {}
  86  
  87  }
  88  ?>