Class Stream

PHP stream implementation

Guzzle\Stream\Stream implements Guzzle\Stream\StreamInterface

Direct known subclasses

Namespace: Guzzle\Stream
Located at src/Guzzle/Stream/Stream.php

Methods summary
`public`	# `__construct( resource $stream, integer $size = null )` Parameters `$stream` Stream resource to wrap `$size` Size of the stream in bytes. Only pass if the size cannot be obtained from the stream. Throws `InvalidArgumentException` if the stream is not a stream resource
`public`	# `__destruct( )` Closes the stream when the helper is destructed Closes the stream when the helper is destructed
`public string`	# `__toString( )` Convert the stream to a string if the stream is readable and the stream is seekable. Convert the stream to a string if the stream is readable and the stream is seekable. Returns string Implementation of `Guzzle\Stream\StreamInterface::__toString()`
`public`	# `close( )` Close the underlying stream Close the underlying stream Implementation of `Guzzle\Stream\StreamInterface::close()`
`public static boolean\|string`	# `getHash( Guzzle\Stream\StreamInterface $stream, string $algo, boolean $rawOutput = false )` Calculate a hash of a Stream Calculate a hash of a Stream Parameters `$stream` Stream to calculate the hash for `$algo` Hash algorithm (e.g. md5, crc32, etc) `$rawOutput` Whether or not to use raw output Returns boolean\|string Returns false on failure or a hash string on success
`public array\|mixed\|null`	# `getMetaData( string $key = null )` Get stream metadata Get stream metadata Parameters `$key` Specific metadata to retrieve Returns array\|mixed\|null Implementation of `Guzzle\Stream\StreamInterface::getMetaData()`
`public resource`	# `getStream( )` Get the stream resource Get the stream resource Returns resource Implementation of `Guzzle\Stream\StreamInterface::getStream()`
`public Guzzle\Stream\Stream`	# `setStream( resource $stream, integer $size = null )` Set the stream that is wrapped by the object Set the stream that is wrapped by the object Parameters `$stream` Stream resource to wrap `$size` Size of the stream in bytes. Only pass if the size cannot be obtained from the stream. Returns `Guzzle\Stream\Stream` Implementation of `Guzzle\Stream\StreamInterface::setStream()`
`public Guzzle\Stream\Stream`	# `detachStream( )` Detach the current stream resource Detach the current stream resource Returns `Guzzle\Stream\Stream` Implementation of `Guzzle\Stream\StreamInterface::detachStream()`
`public string`	# `getWrapper( )` Get the stream wrapper type Get the stream wrapper type Returns string Implementation of `Guzzle\Stream\StreamInterface::getWrapper()`
`public array`	# `getWrapperData( )` Wrapper specific data attached to this stream. Wrapper specific data attached to this stream. Returns array Implementation of `Guzzle\Stream\StreamInterface::getWrapperData()`
`public string`	# `getStreamType( )` Get a label describing the underlying implementation of the stream Get a label describing the underlying implementation of the stream Returns string Implementation of `Guzzle\Stream\StreamInterface::getStreamType()`
`public string`	# `getUri( )` Get the URI/filename associated with this stream Get the URI/filename associated with this stream Returns string Implementation of `Guzzle\Stream\StreamInterface::getUri()`
`public integer\|boolean`	# `getSize( )` Get the size of the stream if able Get the size of the stream if able Returns integer\|boolean Implementation of `Guzzle\Stream\StreamInterface::getSize()`
`public boolean`	# `isReadable( )` Check if the stream is readable Check if the stream is readable Returns boolean Implementation of `Guzzle\Stream\StreamInterface::isReadable()`
`public boolean`	# `isRepeatable( )` Check if the stream is repeatable Check if the stream is repeatable Returns boolean Implementation of `Guzzle\Stream\StreamInterface::isRepeatable()`
`public boolean`	# `isWritable( )` Check if the stream is writable Check if the stream is writable Returns boolean Implementation of `Guzzle\Stream\StreamInterface::isWritable()`
`public boolean`	# `isConsumed( )` Check if the stream has been consumed Check if the stream has been consumed Returns boolean Implementation of `Guzzle\Stream\StreamInterface::isConsumed()`
`public boolean`	# `feof( )` Alias of isConsumed Alias of isConsumed Returns boolean Implementation of `Guzzle\Stream\StreamInterface::feof()`
`public boolean`	# `isLocal( )` Check if the stream is a local stream vs a remote stream Check if the stream is a local stream vs a remote stream Returns boolean Implementation of `Guzzle\Stream\StreamInterface::isLocal()`
`public boolean`	# `isSeekable( )` Check if the string is repeatable Check if the string is repeatable Returns boolean Implementation of `Guzzle\Stream\StreamInterface::isSeekable()`
`public Guzzle\Stream\Stream`	# `setSize( integer $size )` Specify the size of the stream in bytes Specify the size of the stream in bytes Parameters `$size` Size of the stream contents in bytes Returns `Guzzle\Stream\Stream` Implementation of `Guzzle\Stream\StreamInterface::setSize()`
`public boolean`	# `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` Where the offset is applied Returns boolean Returns TRUE on success or FALSE on failure Link http://www.php.net/manual/en/function.fseek.php Implementation of `Guzzle\Stream\StreamInterface::seek()`
`public string\|boolean`	# `read( integer $length )` Read data from the stream Read data from the stream Parameters `$length` Up to length number of bytes read. Returns string\|boolean Returns the data read from the stream or FALSE on failure or EOF Implementation of `Guzzle\Stream\StreamInterface::read()`
`public integer\|boolean`	# `write( string $string )` Write data to the stream Write data to the stream Parameters `$string` The string that is to be written. Returns integer\|boolean Returns the number of bytes written to the stream on success or FALSE on failure. Implementation of `Guzzle\Stream\StreamInterface::write()`
`public integer\|boolean`	# `ftell( )` Returns the current position of the file read/write pointer Returns the current position of the file read/write pointer Returns integer\|boolean Returns the position of the file pointer or false on error Implementation of `Guzzle\Stream\StreamInterface::ftell()`
`public boolean`	# `rewind( )` Rewind to the beginning of the stream Rewind to the beginning of the stream Returns boolean Returns true on success or false on failure Implementation of `Guzzle\Stream\StreamInterface::rewind()`
`public string\|boolean`	# `readLine( integer $maxLength = null )` Read a line from the stream up to the maximum allowed buffer length Read a line from the stream up to the maximum allowed buffer length Parameters `$maxLength` Maximum buffer length Returns string\|boolean Implementation of `Guzzle\Stream\StreamInterface::readLine()`
`public Guzzle\Stream\Stream`	# `setCustomData( string $key, mixed $value )` Set custom data on the stream Set custom data on the stream Parameters `$key` Key to set `$value` Value to set Returns `Guzzle\Stream\Stream` Implementation of `Guzzle\Stream\StreamInterface::setCustomData()`
`public null\|mixed`	# `getCustomData( string $key )` Get custom data from the stream Get custom data from the stream Parameters `$key` Key to retrieve Returns null\|mixed Implementation of `Guzzle\Stream\StreamInterface::getCustomData()`
`protected`	# `rebuildCache( )` Reprocess stream metadata Reprocess stream metadata

Constants summary
`string`	`STREAM_TYPE`	# `'stream_type'`
`string`	`WRAPPER_TYPE`	# `'wrapper_type'`
`string`	`IS_LOCAL`	# `'is_local'`
`string`	`IS_READABLE`	# `'is_readable'`
`string`	`IS_WRITABLE`	# `'is_writable'`
`string`	`SEEKABLE`	# `'seekable'`

Properties summary
`protected resource`	`$stream` Stream resource Stream resource	#
`protected integer`	`$size` Size of the stream contents in bytes Size of the stream contents in bytes	#
`protected array`	`$cache` Stream cached data Stream cached data	# `array()`
`protected array`	`$customData` Custom stream data Custom stream data	# `array()`
`protected static array`	`$readWriteHash` Hash table of readable and writeable stream types for fast lookups Hash table of readable and writeable stream types for fast lookups	# array( 'read' => array( 'r' => true, 'w+' => true, 'r+' => true, 'x+' => true, 'c+' => true, 'rb' => true, 'w+b' => true, 'r+b' => true, 'x+b' => true, 'c+b' => true, 'rt' => true, 'w+t' => true, 'r+t' => true, 'x+t' => true, 'c+t' => true, 'a+' => true ), 'write' => array( 'w' => true, 'w+' => true, 'rw' => true, 'r+' => true, 'x+' => true, 'c+' => true, 'wb' => true, 'w+b' => true, 'r+b' => true, 'x+b' => true, 'c+b' => true, 'w+t' => true, 'r+t' => true, 'x+t' => true, 'c+t' => true, 'a' => true, 'a+' => true ) )

Namespaces

Classes

Interfaces

Class Stream

Direct known subclasses

Parameters

Throws

Returns

Implementation of

Implementation of

Parameters

Returns

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Link

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of