Trait StreamTrait

Provides a set of methods to represent a Psr-7 stream.

NOTE: Most of this was ported from a prior build. Method documentation and some stability refactoring will be added throughout the alpha and beta phase of Oroboros core for code ported

from legacy builds.

Traits provide extended method support to classes without requiring a direct, linear chain of inheritance. This allows functions to inherit subsets of related methods without declaring a parent class.

In Oroboros core, ALL methods are granted to classes via traits, and the classes themselves are just containers that correlate their methods to an interface they are expected to honor. This approach maximizes interoperability, by entirely removing class inheritance as a requirement for extension of any class in this system.

3rd parties using this package are not expected to follow this approach,

but ALL of our internal class and logic structure does.

Direct Known Users

oroboros\core\abstracts\libraries\stream\AbstractStream, oroboros\core\traits\libraries\stream\MessageTrait

Indirect Known Users

oroboros\core\libraries\stream\Stream

Namespace: oroboros\core\traits\libraries\stream
Package: oroboros\core\psr7
Category: traits
License: The MIT License (MIT)
Author: Brian Dayhoff mopsyd@me.com
Version: 0.2.4
Since: 0.2.4-alpha
Used by: oroboros\core\interfaces\api\psr\Psr7Api::STREAM_ABSTRACT_CLASS
Link: bitbucket.org/oroborosframework/oroboros-core/wiki/development/api/traits.md
Satisfies: \oroboros\core\interfaces\contract\libraries\stream\StreamContract
Satisfies: \Psr\Http\Message\StreamInterface
Located at core/traits/libraries/stream/StreamTrait.php

Methods summary

`public`	# `__construct( resource $body )` Creates a new instance of a stream wrapper. Creates a new instance of a stream wrapper. Parameters `$body`
`public`	# `__destruct( )` Destroys any cache files that may exist. A fallback shutdown function is also declared as a redundancy, in the event of a fatal error that prevents the destructor from firing. Destroys any cache files that may exist. A fallback shutdown function is also declared as a redundancy, in the event of a fatal error that prevents the destructor from firing.
`public string`	# `__toString( )` Reads all data from the stream into a string, from the beginning to end. Reads all data from the stream into a string, from the beginning to end. This method MUST attempt to seek to the beginning of the stream before reading data and read the stream until the end is reached. Warning: This could attempt to load a large amount of data into memory. This method MUST NOT raise an exception in order to conform with PHP's string casting operations. Returns string See http://php.net/manual/en/language.oop5.magic.php#object.tostring
`public`	# `rewind( )` Seek to the beginning of the stream. 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). Throws `RuntimeException` on failure. See `oroboros\core\traits\libraries\stream\StreamTrait::seek()` http://www.php.net/manual/en/function.fseek.php
`public string`	# `read( integer $length )` Read data from the stream. Read data from the stream. Parameters `$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. Returns string Returns the data read from the stream, or an empty string if no bytes are available. Throws `RuntimeException` if an error occurs.
`public resource\|null`	# `detach( )` Separates any underlying resources from the stream. Separates any underlying resources from the stream. After the stream has been detached, the stream is in an unusable state. Returns resource\|null Underlying PHP stream, if any
`public integer`	# `write( string $string )` Write data to the stream. Write data to the stream. Parameters `$string` The string that is to be written. Returns integer Returns the number of bytes written to the stream. Throws `RuntimeException` on failure.
`public`	# `close( )` Closes the stream and any underlying resources. Closes the stream and any underlying resources.
`public integer`	# `tell( )` Returns the current position of the file read/write pointer Returns the current position of the file read/write pointer Returns integer Position of the file pointer Throws `RuntimeException` on error.
`public array\|mixed\|null`	# `getMetadata( string $key = null )` Get stream metadata as an associative array or retrieve a specific key. 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 `$key` Specific metadata to retrieve. Returns 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. See http://php.net/manual/en/function.stream-get-meta-data.php
`public boolean`	# `isReadable( )` Returns whether or not the stream is readable. Returns whether or not the stream is readable. Returns boolean
`public string`	# `getContents( )` Returns the remaining contents in a string Returns the remaining contents in a string Returns string Throws `RuntimeException` if unable to read. `RuntimeException` if error occurs while reading.
`public`	# `seek( integer $offset, integer $whence = SEEK_SET )` Seek to a position in the stream. Seek to a position in the stream. Parameters `$offset` Stream offset `$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. Throws `RuntimeException` on failure. See http://www.php.net/manual/en/function.fseek.php
`public boolean`	# `isSeekable( )` Returns whether or not the stream is seekable. Returns whether or not the stream is seekable. Returns boolean
`public integer\|null`	# `getSize( )` Get the size of the stream if known. Get the size of the stream if known. Returns integer\|null Returns the size in bytes if known, or null if unknown.
`public boolean`	# `eof( )` Returns true if the stream is at the end of the stream. Returns true if the stream is at the end of the stream. Returns boolean
`public boolean`	# `isWritable( )` Returns whether or not the stream is writable. Returns whether or not the stream is writable. Returns boolean
`protected`	# `_initializeStream( resource $stream )` Initializes the stream wrapper. Initializes the stream wrapper. Parameters `$stream` Throws `oroboros\core\utilities\exception\Exception`
`private`	# `_createCacheStreamFile( )` Creates a cache stream file, in the event that the passed stream represents a resource that cannot be reused. Creates a cache stream file, in the event that the passed stream represents a resource that cannot be reused. Throws `oroboros\core\utilities\exception\Exception` if the cache directory is not writeable
`private string`	# `_createStreamCacheFileName( )` Creates a non-colliding cache name, based off of the values in the cache directory. Creates a non-colliding cache name, based off of the values in the cache directory. Returns string

Properties summary

`private boolean`	`$_purge_file_on_destruct`	# `false`
`private`	`$_cache_file`	#
`private`	`$_stream`	#
`private`	`$_readable`	#
`private`	`$_writeable`	#
`private`	`$_seekable`	#
`private`	`$_size`	#
`private`	`$_uri`	#
`private`	`$_meta`	#
`private integer`	`$_offset`	# `0`

Namespaces

Traits

Trait StreamTrait

from legacy builds.

but ALL of our internal class and logic structure does.

Direct Known Users

Indirect Known Users

Methods summary

Parameters

Returns

See

Throws

See

Parameters

Returns

Throws

Returns

Parameters

Returns

Throws

Returns

Throws

Parameters

Returns

See

Returns

Returns

Throws

Parameters

Throws

See

Returns

Returns

Returns

Returns

Parameters

Throws

Throws

Returns

Properties summary