## Class Swift_CharacterStream_ArrayCharacterStream

(line 21)

## Description

Located in File: /vendors/swiftMailer/classes/Swift/CharacterStream/ArrayCharacterStream.php

##### A CharacterStream implementation which stores characters in an internal array.

- author: - Chris Corbyn

## Class Variables

Summary:

## Class Constants

Summary:

## Method Detail

Summary:
Swift_CharacterStream_ArrayCharacterStream __construct (Swift_CharacterReaderFactory $factory, string $charset)
void flushContents ()
void importByteStream (Swift_OutputByteStream $os)
void importString (string $string)
string read (int $length)
int[] readBytes (int $length)
void setCharacterReaderFactory (Swift_CharacterReaderFactory $factory)
void setCharacterSet (string $charset)
void setPointer (int $charOffset)
void write (string $chars)

#### Constructor __construct (line 54)

#### Swift_CharacterStream_ArrayCharacterStream __construct( Swift_CharacterReaderFactory $factory, string $charset)

##### Create a new CharacterStream with the given $chars, if set.

#### Parameters

- Swift_CharacterReaderFactory $factory: for loading validators
- string $charset: used in the stream

#### Info

- access - public

#### Method flushContents (line 286)

#### void flushContents( )

Implementation of:

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

##### Empty the stream and reset the internal pointer.

#### Info

- access - public

#### Method importByteStream (line 86)

#### void importByteStream( Swift_OutputByteStream $os)

Implementation of:

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

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

#### Parameters

- Swift_OutputByteStream $os: output stream to read from

#### Info

- access - public

#### Method importString (line 123)

#### void importString( string $string)

Implementation of:

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

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

#### Parameters

- string $string:

#### Info

- access - public

#### Method read (line 135)

#### string read( int $length)

Implementation of:

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

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

#### Parameters

- int $length:

#### Info

- access - public

#### Method readBytes (line 168)

#### int[] readBytes( int $length)

Implementation of:

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

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

#### Parameters

- int $length:

#### Info

- access - public

#### Method setCharacterReaderFactory (line 76)

#### void setCharacterReaderFactory( Swift_CharacterReaderFactory $factory)

Implementation of:

Swift_CharacterStream::setCharacterReaderFactory()
  Set the CharacterReaderFactory for multi charset support.

##### Set the CharacterReaderFactory for multi charset support.

#### Parameters

- Swift_CharacterReaderFactory $factory:

#### Info

- access - public

#### Method setCharacterSet (line 66)

#### void setCharacterSet( string $charset)

Implementation of:

Swift_CharacterStream::setCharacterSet()
  Set the character set used in this CharacterStream.

##### Set the character set used in this CharacterStream.

#### Parameters

- string $charset:

#### Info

- access - public

#### Method setPointer (line 270)

#### void setPointer( int $charOffset)

Implementation of:

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

##### Move the internal pointer to $charOffset in the stream.

#### Parameters

- int $charOffset:

#### Info

- access - public

#### Method write (line 192)

#### void write( string $chars)

Implementation of:

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

##### Write $chars to the end of the stream.

#### Parameters

- string $chars:

#### Info

- access - public

## Inherited Variables

### Inherited Class Variable Summary

## Inherited Methods

### Inherited Method Summary

Documentation generated on Fri, 12 Nov 2010 20:45:12 +0000 by phpDocumentor 1.4.3