Class Swift_ByteStream_FileByteStream

Allows reading and writing of bytes to and from a file.

Swift_ByteStream_AbstractFilterableInputStream implements Swift_InputByteStream, Swift_Filterable

Swift_ByteStream_FileByteStream implements Swift_FileStream

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

Methods summary
`public`	# `__construct( string $path, string $writable = false )` Create a new FileByteStream for $path. Create a new FileByteStream for $path. Parameters `$path` `$writable` if true
`public string`	# `getPath( )` Get the complete path to the file. Get the complete path to the file. Returns string Implementation of `Swift_FileStream::getPath()`
`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` Returns string Throws `Swift_IoException` Implementation of `Swift_OutputByteStream::read()`
`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` Returns boolean Throws `Swift_IoException` Implementation of `Swift_OutputByteStream::setReadPointer()`
`protected`	# `_commit( string $bytes )` Just write the bytes to the file Just write the bytes to the file Parameters `$bytes`
`protected`	# `_flush( )` Not used Not used
`private`	# `_getReadHandle( )` Get the resource for reading Get the resource for reading
`private`	# `_getWriteHandle( )` Get the resource for writing Get the resource for writing
`private`	# `_resetReadHandle( )` Force a reload of the resource for reading Force a reload of the resource for reading
`private`	# `_getReadStreamSeekableStatus( )` Check if ReadOnly Stream is seekable Check if ReadOnly Stream is seekable
`private`	# `_seekReadStreamToPosition( $offset )` Streams in a readOnly stream ensuring copy if needed Streams in a readOnly stream ensuring copy if needed
`private`	# `_copyReadStream( )` Copy a readOnly Stream to ensure seekability Copy a readOnly Stream to ensure seekability

Methods inherited from Swift_ByteStream_AbstractFilterableInputStream
`addFilter(), bind(), commit(), flushBuffers(), removeFilter(), unbind(), write()`

Properties summary
`private integer`	`$_offset` The internal pointer offset The internal pointer offset	# `0`
`private`	`$_path` The path to the file The path to the file	#
`private`	`$_mode` The mode this file is opened in for writing The mode this file is opened in for writing	#
`private`	`$_reader` A lazy-loaded resource handle for reading the file A lazy-loaded resource handle for reading the file	#
`private`	`$_writer` A lazy-loaded resource handle for writing the file A lazy-loaded resource handle for writing the file	#
`private boolean`	`$_quotes` If magic_quotes_runtime is on, this will be true If magic_quotes_runtime is on, this will be true	# `false`
`private`	`$_seekable` If stream is seekable true/false, or null if not known If stream is seekable true/false, or null if not known	# `null`

Properties inherited from Swift_ByteStream_AbstractFilterableInputStream
`$_sequence`

Packages

Classes

Interfaces

Class Swift_ByteStream_FileByteStream

Parameters

Returns

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters

Returns

Throws

Implementation of

Parameters