Class Swift_ByteStream_AbstractFilterableInputStream

Provides the base functionality for an InputStream supporting filters.

Swift_ByteStream_AbstractFilterableInputStream implements Swift_InputByteStream, Swift_Filterable

Direct known subclasses

Swift_ByteStream_FileByteStream, Swift_Transport_StreamBuffer

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

Methods summary

`abstract protected`	# `_commit( string $bytes )` Commit the given bytes to the storage medium immediately. Commit the given bytes to the storage medium immediately. Parameters `$bytes` `string` $bytes
`abstract protected`	# `_flush( )` Flush any buffers/content with immediate effect. Flush any buffers/content with immediate effect.
`public`	# `addFilter( Swift_StreamFilter $filter, string $key )` Add a StreamFilter to this InputByteStream. Add a StreamFilter to this InputByteStream. Parameters `$filter` `Swift_StreamFilter` $filter `$key` `string` $key Implementation of `Swift_Filterable::addFilter()`
`public`	# `removeFilter( string $key )` Remove an already present StreamFilter based on its $key. Remove an already present StreamFilter based on its $key. Parameters `$key` `string` $key Implementation of `Swift_Filterable::removeFilter()`
`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( )` For any bytes that are currently buffered inside the stream, force them off the buffer. For any bytes that are currently buffered inside the stream, force them off the buffer. 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_AbstractFilterableInputStream::write()` and `Swift_ByteStream_AbstractFilterableInputStream::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_AbstractFilterableInputStream::write()` and `Swift_ByteStream_AbstractFilterableInputStream::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`	# `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()`
`private`	# `_filter( mixed $bytes )` Run $bytes through all filters Run $bytes through all filters
`private`	# `_doWrite( mixed $bytes )` Just write the bytes to the stream Just write the bytes to the stream

Magic methods summary

Properties summary

`protected integer`	`$_sequence`	# Write sequence Write sequence
`private array`	`$_filters`	# StreamFilters StreamFilters
`private string`	`$_writeBuffer`	# A buffer for writing A buffer for writing
`private array`	`$_mirrors`	# Bound streams Bound streams

Packages

Classes

Interfaces

Class Swift_ByteStream_AbstractFilterableInputStream

Direct known subclasses

Methods summary

Parameters

Parameters

Implementation of

Parameters

Implementation of

Parameters

Returns

Throws

Implementation of

Throws

Implementation of

Parameters

Implementation of

Parameters

Implementation of

Throws

Implementation of

Magic methods summary

Properties summary