[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /*
   4   * This file is part of SwiftMailer.
   5   * (c) 2004-2009 Chris Corbyn
   6   *
   7   * For the full copyright and license information, please view the LICENSE
   8   * file that was distributed with this source code.
   9   */
  10  
  11  /**
  12   * An abstract means of reading and writing data in terms of characters as opposed
  13   * to bytes.
  14   *
  15   * Classes implementing this interface may use a subsystem which requires less
  16   * memory than working with large strings of data.
  17   *
  18   * @author Chris Corbyn
  19   */
  20  interface Swift_CharacterStream
  21  {
  22      /**
  23       * Set the character set used in this CharacterStream.
  24       *
  25       * @param string $charset
  26       */
  27      public function setCharacterSet($charset);
  28  
  29      /**
  30       * Set the CharacterReaderFactory for multi charset support.
  31       */
  32      public function setCharacterReaderFactory(Swift_CharacterReaderFactory $factory);
  33  
  34      /**
  35       * Overwrite this character stream using the byte sequence in the byte stream.
  36       *
  37       * @param Swift_OutputByteStream $os output stream to read from
  38       */
  39      public function importByteStream(Swift_OutputByteStream $os);
  40  
  41      /**
  42       * Import a string a bytes into this CharacterStream, overwriting any existing
  43       * data in the stream.
  44       *
  45       * @param string $string
  46       */
  47      public function importString($string);
  48  
  49      /**
  50       * Read $length characters from the stream and move the internal pointer
  51       * $length further into the stream.
  52       *
  53       * @param int $length
  54       *
  55       * @return string
  56       */
  57      public function read($length);
  58  
  59      /**
  60       * Read $length characters from the stream and return a 1-dimensional array
  61       * containing there octet values.
  62       *
  63       * @param int $length
  64       *
  65       * @return int[]
  66       */
  67      public function readBytes($length);
  68  
  69      /**
  70       * Write $chars to the end of the stream.
  71       *
  72       * @param string $chars
  73       */
  74      public function write($chars);
  75  
  76      /**
  77       * Move the internal pointer to $charOffset in the stream.
  78       *
  79       * @param int $charOffset
  80       */
  81      public function setPointer($charOffset);
  82  
  83      /**
  84       * Empty the stream and reset the internal pointer.
  85       */
  86      public function flushContents();
  87  }