Class Swift_ByteStream_ArrayByteStream

Allows reading and writing of bytes to and from an array.

Swift_ByteStream_ArrayByteStream implements Swift_InputByteStream, Swift_OutputByteStream

Package: Swift\ByteStream
Author: Chris Corbyn
Located at vendors/swiftmailer/lib/classes/Swift/ByteStream/ArrayByteStream.php

Methods summary

`public`	# `__construct( mixed $stack = null )` Create a new ArrayByteStream. If $stack is given the stream will be populated with the bytes it contains. Create a new ArrayByteStream. If $stack is given the stream will be populated with the bytes it contains. Parameters `$stack` `mixed` $stack of bytes in string or array form, optional
`public string`	# `read( integer $length )` Reads $length bytes from the stream into a string and moves the pointer through the stream by $length. If less bytes exist than are requested the remaining bytes are given instead. If no bytes are remaining at all, boolean false is returned. Reads $length bytes from the stream into a string and moves the pointer through the stream by $length. If less bytes exist than are requested the remaining bytes are given instead. If no bytes are remaining at all, boolean false is returned. Parameters `$length` `integer` $length Returns `string` Throws `Swift_IoException` Implementation of `Swift_OutputByteStream::read()`
`public integer`	# `write( string $bytes )` Writes $bytes to the end of the stream. Writes $bytes to the end of the stream. Parameters `$bytes` `string` $bytes Returns `integer` Throws `Swift_IoException` Implementation of `Swift_InputByteStream::write()`
`public`	# `commit( )` Not used. Not used. Throws `Swift_IoException` Implementation of `Swift_InputByteStream::commit()`
`public`	# `bind( Swift_InputByteStream $is )` Attach $is to this stream. The stream acts as an observer, receiving all data that is written. All `Swift_ByteStream_ArrayByteStream::write()` and `Swift_ByteStream_ArrayByteStream::flushBuffers()` operations will be mirrored. Attach $is to this stream. The stream acts as an observer, receiving all data that is written. All `Swift_ByteStream_ArrayByteStream::write()` and `Swift_ByteStream_ArrayByteStream::flushBuffers()` operations will be mirrored. Parameters `$is` `Swift_InputByteStream` $is Implementation of `Swift_InputByteStream::bind()`
`public`	# `unbind( Swift_InputByteStream $is )` Remove an already bound stream. If $is is not bound, no errors will be raised. If the stream currently has any buffered data it will be written to $is before unbinding occurs. Remove an already bound stream. If $is is not bound, no errors will be raised. If the stream currently has any buffered data it will be written to $is before unbinding occurs. Parameters `$is` `Swift_InputByteStream` $is Implementation of `Swift_InputByteStream::unbind()`
`public boolean`	# `setReadPointer( integer $byteOffset )` Move the internal read pointer to $byteOffset in the stream. Move the internal read pointer to $byteOffset in the stream. Parameters `$byteOffset` `integer` $byteOffset Returns `boolean` Throws `Swift_IoException` Implementation of `Swift_OutputByteStream::setReadPointer()`
`public`	# `flushBuffers( )` Flush the contents of the stream (empty it) and set the internal pointer to the beginning. Flush the contents of the stream (empty it) and set the internal pointer to the beginning. Throws `Swift_IoException` Implementation of `Swift_InputByteStream::flushBuffers()`

Magic methods summary

Properties summary

`private string[]`	`$_array`	# The internal stack of bytes. The internal stack of bytes.
`private integer`	`$_arraySize`	# The size of the stack The size of the stack
`private integer`	`$_offset`	# The internal pointer offset. The internal pointer offset.
`private array`	`$_mirrors`	# Bound streams Bound streams

Packages

Classes

Interfaces

Class Swift_ByteStream_ArrayByteStream

Methods summary

Parameters

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Throws

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Parameters

Returns

Throws

Implementation of

Throws

Implementation of

Magic methods summary

Properties summary