Swift_ByteStream_TemporaryFileByteStream
extends Swift_ByteStream_FileByteStream
in package
Allows reading and writing of bytes to and from a file.
Tags
Table of Contents
- $sequence : mixed
- Write sequence.
- $filters : array<string|int, Swift_StreamFilter>
- StreamFilters.
- $mirrors : array<string|int, Swift_InputByteStream>
- Bound streams.
- $mode : mixed
- The mode this file is opened in for writing
- $offset : mixed
- The internal pointer offset
- $path : mixed
- The path to the file
- $reader : mixed
- A lazy-loaded resource handle for reading the file
- $seekable : mixed
- If stream is seekable true/false, or null if not known
- $writeBuffer : mixed
- A buffer for writing.
- $writer : mixed
- A lazy-loaded resource handle for writing the file
- __construct() : mixed
- Create a new FileByteStream for $path.
- __destruct() : mixed
- addFilter() : mixed
- Add a StreamFilter to this InputByteStream.
- bind() : mixed
- Attach $is to this stream.
- commit() : mixed
- For any bytes that are currently buffered inside the stream, force them off the buffer.
- flushBuffers() : mixed
- Flush the contents of the stream (empty it) and set the internal pointer to the beginning.
- getContent() : mixed
- getPath() : string
- Get the complete path to the file.
- read() : string|bool
- Reads $length bytes from the stream into a string and moves the pointer through the stream by $length.
- removeFilter() : mixed
- Remove an already present StreamFilter based on its $key.
- setReadPointer() : bool
- Move the internal read pointer to $byteOffset in the stream.
- unbind() : mixed
- Remove an already bound stream.
- write() : int
- Writes $bytes to the end of the stream.
- doCommit() : mixed
- Commit the given bytes to the storage medium immediately.
- flush() : mixed
- Flush any buffers/content with immediate effect.
- copyReadStream() : mixed
- Copy a readOnly Stream to ensure seekability
- doWrite() : mixed
- Just write the bytes to the stream
- filter() : mixed
- Run $bytes through all filters
- getReadHandle() : mixed
- Get the resource for reading
- getReadStreamSeekableStatus() : mixed
- Check if ReadOnly Stream is seekable
- getWriteHandle() : mixed
- Get the resource for writing
- resetReadHandle() : mixed
- Force a reload of the resource for reading
- seekReadStreamToPosition() : mixed
- Streams in a readOnly stream ensuring copy if needed
Properties
$sequence
Write sequence.
protected
mixed
$sequence
= 0
$filters
StreamFilters.
private
array<string|int, Swift_StreamFilter>
$filters
= []
$mirrors
Bound streams.
private
array<string|int, Swift_InputByteStream>
$mirrors
= []
$mode
The mode this file is opened in for writing
private
mixed
$mode
$offset
The internal pointer offset
private
mixed
$offset
= 0
$path
The path to the file
private
mixed
$path
$reader
A lazy-loaded resource handle for reading the file
private
mixed
$reader
$seekable
If stream is seekable true/false, or null if not known
private
mixed
$seekable
=
ull
$writeBuffer
A buffer for writing.
private
mixed
$writeBuffer
= ''
$writer
A lazy-loaded resource handle for writing the file
private
mixed
$writer
Methods
__construct()
Create a new FileByteStream for $path.
public
__construct() : mixed
Return values
mixed —__destruct()
public
__destruct() : mixed
Return values
mixed —addFilter()
Add a StreamFilter to this InputByteStream.
public
addFilter(Swift_StreamFilter $filter, string $key) : mixed
Parameters
- $filter : Swift_StreamFilter
- $key : string
Return values
mixed —bind()
Attach $is to this stream.
public
bind(Swift_InputByteStream $is) : mixed
The stream acts as an observer, receiving all data that is written. All and operations will be mirrored.
Parameters
- $is : Swift_InputByteStream
Return values
mixed —commit()
For any bytes that are currently buffered inside the stream, force them off the buffer.
public
commit() : mixed
Tags
Return values
mixed —flushBuffers()
Flush the contents of the stream (empty it) and set the internal pointer to the beginning.
public
flushBuffers() : mixed
Tags
Return values
mixed —getContent()
public
getContent() : mixed
Return values
mixed —getPath()
Get the complete path to the file.
public
getPath() : string
Return values
string —read()
Reads $length bytes from the stream into a string and moves the pointer through the stream by $length.
public
read(int $length) : string|bool
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 : int
Tags
Return values
string|bool —removeFilter()
Remove an already present StreamFilter based on its $key.
public
removeFilter(string $key) : mixed
Parameters
- $key : string
Return values
mixed —setReadPointer()
Move the internal read pointer to $byteOffset in the stream.
public
setReadPointer(int $byteOffset) : bool
Parameters
- $byteOffset : int
Return values
bool —unbind()
Remove an already bound stream.
public
unbind(Swift_InputByteStream $is) : mixed
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
Return values
mixed —write()
Writes $bytes to the end of the stream.
public
write(string $bytes) : int
Parameters
- $bytes : string
Tags
Return values
int —doCommit()
Commit the given bytes to the storage medium immediately.
protected
abstract doCommit(string $bytes) : mixed
Parameters
- $bytes : string
Return values
mixed —flush()
Flush any buffers/content with immediate effect.
protected
abstract flush() : mixed
Return values
mixed —copyReadStream()
Copy a readOnly Stream to ensure seekability
private
copyReadStream() : mixed
Return values
mixed —doWrite()
Just write the bytes to the stream
private
doWrite(mixed $bytes) : mixed
Parameters
- $bytes : mixed
Return values
mixed —filter()
Run $bytes through all filters
private
filter(mixed $bytes) : mixed
Parameters
- $bytes : mixed
Return values
mixed —getReadHandle()
Get the resource for reading
private
getReadHandle() : mixed
Return values
mixed —getReadStreamSeekableStatus()
Check if ReadOnly Stream is seekable
private
getReadStreamSeekableStatus() : mixed
Return values
mixed —getWriteHandle()
Get the resource for writing
private
getWriteHandle() : mixed
Return values
mixed —resetReadHandle()
Force a reload of the resource for reading
private
resetReadHandle() : mixed
Return values
mixed —seekReadStreamToPosition()
Streams in a readOnly stream ensuring copy if needed
private
seekReadStreamToPosition(mixed $offset) : mixed
Parameters
- $offset : mixed