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

Class: Swift_CharacterStream_ArrayCharacterStream

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

Class Overview


A CharacterStream implementation which stores characters in an internal array.


Author(s):

  • Chris Corbyn

Implements interfaces:

Methods



Class Details

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



Tags:

author:  Chris Corbyn


[ Top ]


Class Methods


constructor __construct [line 48]

Swift_CharacterStream_ArrayCharacterStream __construct( Swift_CharacterReaderFactory $factory, string $charset)

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



Tags:

access:  public


Parameters:

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

[ Top ]

method flushContents [line 262]

void flushContents( )

Empty the stream and reset the internal pointer.



Tags:

access:  public



Implementation of:
Swift_CharacterStream::flushContents()
Empty the stream and reset the internal pointer.
[ Top ]

method importByteStream [line 81]

void importByteStream( Swift_OutputByteStream $os)

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



Tags:

access:  public



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

Parameters:

Swift_OutputByteStream   $os   output stream to read from

[ Top ]

method importString [line 114]

void importString( string $string)

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



Tags:

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 128]

string read( int $length)

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



Tags:

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 160]

integer[] readBytes( int $length)

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



Tags:

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 71]

void setCharacterReaderFactory( Swift_CharacterReaderFactory $factory)

Set the CharacterReaderFactory for multi charset support.



Tags:

access:  public



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

Parameters:

Swift_CharacterReaderFactory   $factory  

[ Top ]

method setCharacterSet [line 60]

void setCharacterSet( string $charset)

Set the character set used in this CharacterStream.



Tags:

access:  public



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

Parameters:

string   $charset  

[ Top ]

method setPointer [line 249]

void setPointer( int $charOffset)

Move the internal pointer to $charOffset in the stream.



Tags:

access:  public



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

Parameters:

int   $charOffset  

[ Top ]

method write [line 183]

void write( string $chars)

Write $chars to the end of the stream.



Tags:

access:  public



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

Parameters:

string   $chars  

[ Top ]


Documentation generated on Sun, 02 Oct 2016 07:43:33 +0000 by phpDocumentor 1.4.3