1. class
  2. Cjpg
  3. \
  4. Bitcoin
  5. \
  6. Blk
  7. \
  8. Readers
  9. \
  10. Stream

Stream

final class Stream (View source)

internal  
 

An internal stream class for reading the blk files.

Constants

SEEK_SET

Set position equal to offset bytes.

@
SEEK_CUR

Set position to current location plus offset.
SEEK_END

Set position to end-of-file plus offset.

Properties

protected resource|null $stream

The underlying stream resource

Methods

__construct(resource|Stream $stream)

Initialize a new stream from a resource or {IStream}

static Stream|null
fromString(string $string = '')

Create a new stream from a string.

static Stream|null
fromFile(string $filename, string $mode = 'r+')

Create a stream from an existing file.

void
close()

Closes the stream.

resource|null
detach()

Get the current stream and separates it from the current instance.

int|null
getSize()

Get the size of the stream.

int|null
tell()

Returns the current position of the file read/write pointer

bool
eof()

Returns true if the stream is at the end of the stream.

bool
isSeekable()

Returns whether or not the stream is seekable.

void
seek(int $offset, int $whence = SEEK_SET)

Seek to a position in the stream.

void
rewind()

Seek to the beginning of the stream.

bool
isWritable()

Returns whether or not the stream is writable.

int
write(string $string)

Write data to the stream.

bool
isReadable()

Returns whether or not the stream is readable.

int
readVarInt()

Read a variable int.

string
read(int $length)

Read data from the stream.

string
getContents()

Returns the remaining contents in a string

array|mixed|null
getMetadata(string $key = null)

Get stream metadata as an associative array or retrieve a specific key.

string
__toString()

Gets the stream into a string

void
__destruct()

Closes the stream.

Details

at line 52
__construct(resource|Stream $stream)

Initialize a new stream from a resource or {IStream}

if $stream is a {\Cjpg\Bitcoin\Blk\Readers\IStream} it will be rewinded and detached from the source

Parameters

resource|Stream $stream

at line 80
static Stream|null fromString(string $string = '')

Create a new stream from a string.

Note that this will create a new file with the help of {\Cjpg\Bitcoin\Blk\Readers\tmpfile()}, if you do not call {\Cjpg\Bitcoin\Blk\Readers\Stream::close()} the file will remain on the system.

Parameters

string $string

Return Value

Stream|null

returns null if fopen php://temp fails

at line 97
static Stream|null fromFile(string $filename, string $mode = 'r+')

Create a stream from an existing file.

Parameters

string $filename

Filename or stream URI to use as basis of stream.
string $mode

Mode with which to open the underlying filename/stream.

Return Value

Stream|null

at line 113
void close()

Closes the stream.

Return Value

void

at line 126
resource|null detach()

Get the current stream and separates it from the current instance.

Return Value

resource|null

at line 139
int|null getSize()

Get the size of the stream.

Return Value

int|null

Returns the size in bytes if known, or null if unknown.

at line 156
int|null tell()

Returns the current position of the file read/write pointer

Return Value

int|null

Position of the file pointer

Exceptions

RuntimeException

at line 171
bool eof()

Returns true if the stream is at the end of the stream.

Return Value

bool

at line 181
bool isSeekable()

Returns whether or not the stream is seekable.

Return Value

bool

at line 198
void seek(int $offset, int $whence = SEEK_SET)

Seek to a position in the stream.

Parameters

int $offset

Stream offset
int $whence

Specifies how the cursor position will be calculated based on the seek offset. Valid values are identical to the built-in PHP $whence values for fseek(). SEEK_SET: Set position equal to offset bytes SEEK_CUR: Set position to current location plus offset SEEK_END: Set position to end-of-stream plus offset.

Return Value

void

Exceptions

RuntimeException

at line 215
void rewind()

Seek to the beginning of the stream.

If the stream is not seekable, this method will raise an exception; otherwise, it will perform a seek(0).

Return Value

void

Exceptions

RuntimeException

See also

seek()

at line 228
bool isWritable()

Returns whether or not the stream is writable.

Return Value

bool

at line 243
int write(string $string)

Write data to the stream.

Parameters

string $string

The string that is to be written.

Return Value

int

Returns the number of bytes written to the stream.

Exceptions

RuntimeException

at line 260
bool isReadable()

Returns whether or not the stream is readable.

Return Value

bool

at line 273
int readVarInt()

Read a variable int.

Return Value

int

at line 296
string read(int $length)

Read data from the stream.

Parameters

int $length

Read up to $length bytes from the object and return them. Fewer than $length bytes may be returned if underlying stream call returns fewer bytes.

Return Value

string

Returns the data read from the stream, or an empty string if no bytes are available.

Exceptions

RuntimeException

at line 311
string getContents()

Returns the remaining contents in a string

Return Value

string

Exceptions

RuntimeException

at line 335
array|mixed|null getMetadata(string $key = null)

Get stream metadata as an associative array or retrieve a specific key.

The keys returned are identical to the keys returned from PHP's stream_get_meta_data() function.

Parameters

string $key

Specific metadata to retrieve.

Return Value

array|mixed|null

Returns an associative array if no key is provided. Returns a specific key value if a key is provided and the value is found, or null if the key is not found.

at line 353
string __toString()

Gets the stream into a string

Return Value

string

at line 370
void __destruct()

Closes the stream.

Return Value

void