Docs For Class Swift_CharacterStream

Class: Swift_CharacterStream_NgCharacterStream

Class Details

[line 32]
A CharacterStream implementation which stores characters in an internal array.

Tags:

author:	Xavier De Cock <xdecock@gmail.com>
filesource:	Source Code for this file

Class Methods

constructor __construct [line 105]

Swift_CharacterStream_NgCharacterStream __construct(
Swift_CharacterReaderFactory
$factory, unknown_type
$charset)

The constructor

Tags:

access:

public

Parameters:

Swift_CharacterReaderFactory	$factory
unknown_type	$charset

[ Top ]

method flushContents [line 139]

void flushContents(
)

Tags:

see:	Swift_CharacterStream::flushContents()
access:	public

Implementation of:

Swift_CharacterStream::flushContents(): Empty the stream and reset the internal pointer.

[ Top ]

method importByteStream [line 153]

void importByteStream(
Swift_OutputByteStream
$os)

Tags:

see:	Swift_CharacterStream::importByteStream()
access:	public

Implementation of:

Swift_CharacterStream::importByteStream(): Overwrite this character stream using the byte sequence in the byte stream.

Parameters:

Swift_OutputByteStream

$os

[ Top ]

method importString [line 167]

void importString(
string
$string)

Tags:

see:	Swift_CharacterStream::importString()
access:	public

Implementation of:

Swift_CharacterStream::importString(): Import a string a bytes into this CharacterStream, overwriting any existing data in the stream.

Parameters:

string

$string

[ Top ]

method read [line 179]

string read(
int
$length)

Tags:

see:	Swift_CharacterStream::read()
access:	public

Implementation of:

Swift_CharacterStream::read(): Read $length characters from the stream and move the internal pointer $length further into the stream.

Parameters:

int

$length

[ Top ]

method readBytes [line 251]

int[] readBytes(
int
$length)

Tags:

see:	Swift_CharacterStream::readBytes()
access:	public

Implementation of:

Swift_CharacterStream::readBytes(): Read $length characters from the stream and return a 1-dimensional array containing there octet values.

Parameters:

int

$length

[ Top ]

method setCharacterReaderFactory [line 129]

void setCharacterReaderFactory(
Swift_CharacterReaderFactory
$factory)

Set the CharacterReaderFactory for multi charset support.

Parameters:

Swift_CharacterReaderFactory

$factory

[ Top ]

method setCharacterSet [line 118]

void setCharacterSet(
string
$charset)

Set the character set used in this CharacterStream.

Parameters:

string

$charset

[ Top ]

method setPointer [line 267]

void setPointer(
int
$charOffset)

Tags:

see:	Swift_CharacterStream::setPointer()
access:	public

Implementation of:

Swift_CharacterStream::setPointer(): Move the internal pointer to $charOffset in the stream.

Parameters:

int

$charOffset

[ Top ]

method write [line 280]

void write(
string
$chars)

Tags:

see:	Swift_CharacterStream::write()
access:	public

Implementation of:

Swift_CharacterStream::write(): Write $chars to the end of the stream.

Parameters:

string

$chars

[ Top ]

Documentation generated on Mon, 05 Sep 2011 20:33:49 -0500 by phpDocumentor 1.4.3

Class: Swift_CharacterStream_NgCharacterStream

Class Overview

Author(s):

Methods

Class Details

Tags:

Class Methods

constructor __construct [line 105]

Tags:

Parameters:

method flushContents [line 139]

Tags:

method importByteStream [line 153]

Tags:

Parameters:

method importString [line 167]

Tags:

Parameters:

method read [line 179]

Tags:

Parameters:

method readBytes [line 251]

Tags:

Parameters:

method setCharacterReaderFactory [line 129]

Tags:

Parameters:

method setCharacterSet [line 118]

Tags:

Parameters:

method setPointer [line 267]

Tags:

Parameters:

method write [line 280]

Tags:

Parameters: