StreamFunctions
in package
Wrapper around PHP stream functions.
Facilitates mocking/stubbing stream operations in unit tests.
Tags
Table of Contents
- $_instance : mixed
- fclose() : mixed
- feof() : mixed
- fgets() : mixed
- fopen() : mixed
- fread() : mixed
- fsockopen() : mixed
- fwrite() : mixed
- instance() : mixed
- Singleton accessor.
- pfsockopen() : mixed
- setInstance() : mixed
- Sets an alternative or mocked instance.
- stream_set_timeout() : mixed
- unsetInstance() : mixed
- Unsets the instance, so a new one will be created.
Properties
$_instance
private
static mixed
$_instance
Methods
fclose()
public
fclose(mixed $handle) : mixed
Parameters
- $handle : mixed
Return values
mixed —feof()
public
feof(mixed $handle) : mixed
Parameters
- $handle : mixed
Return values
mixed —fgets()
public
fgets(mixed $handle[, mixed $length = null ]) : mixed
Parameters
- $handle : mixed
- $length : mixed = null
Return values
mixed —fopen()
public
fopen(mixed $filename, mixed $mode) : mixed
Parameters
- $filename : mixed
- $mode : mixed
Return values
mixed —fread()
public
fread(mixed $handle, mixed $length) : mixed
Parameters
- $handle : mixed
- $length : mixed
Return values
mixed —fsockopen()
public
fsockopen(mixed $hostname[, mixed $port = -1 ][, mixed &$errno = null ][, mixed &$errstr = null ][, mixed $timeout = null ]) : mixed
Parameters
- $hostname : mixed
- $port : mixed = -1
- $errno : mixed = null
- $errstr : mixed = null
- $timeout : mixed = null
Return values
mixed —fwrite()
public
fwrite(mixed $handle, mixed $string[, mixed $length = null ]) : mixed
Parameters
- $handle : mixed
- $string : mixed
- $length : mixed = null
Return values
mixed —instance()
Singleton accessor.
public
static instance() : mixed
Return values
mixed —pfsockopen()
public
pfsockopen(mixed $hostname[, mixed $port = -1 ][, mixed &$errno = null ][, mixed &$errstr = null ][, mixed $timeout = null ]) : mixed
Parameters
- $hostname : mixed
- $port : mixed = -1
- $errno : mixed = null
- $errstr : mixed = null
- $timeout : mixed = null
Return values
mixed —setInstance()
Sets an alternative or mocked instance.
public
setInstance(mixed $instance) : mixed
Parameters
- $instance : mixed
Return values
mixed —stream_set_timeout()
public
stream_set_timeout(mixed $stream, mixed $seconds, mixed $microseconds) : mixed
Parameters
- $stream : mixed
- $seconds : mixed
- $microseconds : mixed
Return values
mixed —unsetInstance()
Unsets the instance, so a new one will be created.
public
unsetInstance() : mixed