\Pop\Mail\Transport\Smtp\Stream\ByteFileByteStream

addFilter()

addFilter(\Pop\Mail\Transport\Smtp\Stream\FilterInterface  $filter, string  $key) 

Add a StreamFilter to this InputByteStream

Parameters

removeFilter()

removeFilter(string  $key) 

Remove an already present StreamFilter based on its $key

Parameters

write()

write(string  $bytes) : integer

Writes $bytes to the end of the stream

Writing may not happen immediately if the stream chooses to buffer. If you want to write these bytes with immediate effect, call \commit() after calling write().

This method returns the sequence ID of the write (i.e. 1 for first, 2 for second, etc etc).

Parameters

Returns

commit()

commit() 

For any bytes that are currently buffered inside the stream, force them off the buffer

bind()

bind(\Pop\Mail\Transport\Smtp\Stream\Byte\InputInterface  $is) 

Attach $is to this stream.

The stream acts as an observer, receiving all data that is written. All \write() and \flushBuffers() operations will be mirrored.

Parameters

unbind()

unbind(\Pop\Mail\Transport\Smtp\Stream\Byte\InputInterface  $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.

Parameters

flushBuffers()

flushBuffers() 

Flush the contents of the stream (empty it) and set the internal pointer to the beginning.

__construct()

__construct(string  $path, boolean  $writable = false) 

Create a new FileByteStream for $path.

Parameters

Throws

\Pop\Mail\Transport\Smtp\Stream\Byte\Exception

getPath()

getPath() : string

Get the complete path to the file

Returns

read()

read(integer  $length) : string|boolean

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

Throws

\Pop\Mail\Transport\Smtp\Stream\Byte\Exception

Returns

setReadPointer()

setReadPointer(integer  $byteOffset) : boolean

Move the internal read pointer to $byteOffset in the stream

Parameters

Returns

commitBytes()

commitBytes(string  $bytes) 

Just write the bytes to the file

Parameters

flush()

flush() 

Not used

filter()

filter(integer  $bytes) : integer

Run $bytes through all filters

Parameters

Returns

doWrite()

doWrite(integer  $bytes) 

Just write the bytes to the stream

Parameters

getReadHandle()

getReadHandle() : resource

Get the resource for reading

Throws

\Pop\Mail\Transport\Smtp\Stream\Byte\Exception

Returns

getWriteHandle()

getWriteHandle() : resource

Get the resource for writing

Throws

\Pop\Mail\Transport\Smtp\Stream\Byte\Exception

Returns

resetReadHandle()

resetReadHandle() 

Force a reload of the resource for reading

getReadStreamSeekableStatus()

getReadStreamSeekableStatus() 

Check if ReadOnly Stream is seekable

seekReadStreamToPosition()

seekReadStreamToPosition(integer  $offset) 

Streams in a readOnly stream ensuring copy if needed

Parameters

copyReadStream()

copyReadStream() 

Copy a readOnly Stream to ensure seekability