StreamWrapper

Allows PSR-7 streams to be used as PHP streams.

class StreamWrapper

Based on Guzzle PSR7 stream wrapper and MongoDB's PHP library stream wrapper.

Copyright: 2015-2016 Appertly

License: Apache-2.0

Instance Properties

Public
Name	Type	Summary
`$context`	`resource`	The stream context

Instance Methods

Public
Returns	Signature and Description
`bool`	`stream_eof`()
`void`	`stream_open`(`string $path`, `string $mode`, `int $options`, `?string &"$opened_path`)
`string`	`stream_read`(`int $count`)
`bool`	`stream_seek`(`int $offset`, `int $whence = SEEK_SET`)
`array`<`arraykey`,`int`>	`stream_stat`()
`int`	`stream_tell`()
`int`	`stream_write`(`string $data`)

Static Methods

Public
Returns	Signature and Description
`resource`	`getResource`(`StreamInterface $stream`) Gets a PHP stream resource for the provided PSR-7 stream.
`void`	`register`() Registers this stream wrapper
`void`	`unregister`() Unregisters this stream wrapper

Property Details

$context

public resource $context

The stream context

Method Details

getResource

public static function getResource(StreamInterface $stream)

Gets a PHP stream resource for the provided PSR-7 stream.

Parameters
Name	Type	Description
`$stream`	`StreamInterface`	The stream to wrap

Returns
Type	Description
`resource`	The generated resource

Throws
Type	Conditions
`InvalidArgumentException`	if stream is not readable or writable

register

public static function register()

Registers this stream wrapper

stream_eof

public function stream_eof()

Returns
Type	Description
`bool`

stream_open

public function stream_open(string $path, string $mode, int $options, ?string &"$opened_path)

Parameters
Name	Type	Description
`$path`	`string`
`$mode`	`string`
`$options`	`int`
`$opened_path`	`?string`

Returns
Type	Description
`void`

stream_read

public function stream_read(int $count)

Parameters
Name	Type	Description
`$count`	`int`

Returns
Type	Description
`string`

stream_seek

public function stream_seek(int $offset, int $whence = SEEK_SET)

Parameters
Name	Type	Description
`$offset`	`int`
`$whence`	`int`

Returns
Type	Description
`bool`

stream_stat

public function stream_stat()

Returns
Type	Description
`array`<`arraykey`,`int`>

stream_tell

public function stream_tell()

Returns
Type	Description
`int`

stream_write

public function stream_write(string $data)

Parameters
Name	Type	Description
`$data`	`string`

Returns
Type	Description
`int`

unregister

public static function unregister()

Unregisters this stream wrapper