Geeklog
[ class tree: Geeklog ] [ index: Geeklog ] [ all elements ]

Class: Swift_CharacterStream

Source Location: /system/vendor/swiftmailer/swiftmailer/lib/classes/Swift/CharacterStream.php

Interface Overview


An abstract means of reading and writing data in terms of characters as opposed to bytes.


Author(s):

  • Chris Corbyn

Methods



Class Details

[line 20]
An abstract means of reading and writing data in terms of characters as opposed to bytes.

Classes implementing this interface may use a subsystem which requires less memory than working with large strings of data.




Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


method flushContents [line 88]

void flushContents( )

Empty the stream and reset the internal pointer.



Tags:

access:  public


[ Top ]

method importByteStream [line 41]

void importByteStream( Swift_OutputByteStream $os)

Overwrite this character stream using the byte sequence in the byte stream.



Tags:

access:  public


Parameters:

Swift_OutputByteStream   $os   output stream to read from

[ Top ]

method importString [line 49]

void importString( string $string)

Import a string a bytes into this CharacterStream, overwriting any existing data in the stream.



Tags:

access:  public


Parameters:

string   $string  

[ Top ]

method read [line 59]

string read( int $length)

Read $length characters from the stream and move the internal pointer $length further into the stream.



Tags:

access:  public


Parameters:

int   $length  

[ Top ]

method readBytes [line 69]

int[] readBytes( int $length)

Read $length characters from the stream and return a 1-dimensional array containing there octet values.



Tags:

access:  public


Parameters:

int   $length  

[ Top ]

method setCharacterReaderFactory [line 34]

void setCharacterReaderFactory( Swift_CharacterReaderFactory $factory)

Set the CharacterReaderFactory for multi charset support.



Tags:

access:  public


Parameters:

Swift_CharacterReaderFactory   $factory  

[ Top ]

method setCharacterSet [line 27]

void setCharacterSet( string $charset)

Set the character set used in this CharacterStream.



Tags:

access:  public


Parameters:

string   $charset  

[ Top ]

method setPointer [line 83]

void setPointer( int $charOffset)

Move the internal pointer to $charOffset in the stream.



Tags:

access:  public


Parameters:

int   $charOffset  

[ Top ]

method write [line 76]

void write( string $chars)

Write $chars to the end of the stream.



Tags:

access:  public


Parameters:

string   $chars  

[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:46:17 +0000 by phpDocumentor 1.4.3