ILIAS\Filesystem\Util\PHPStreamFunctions Class Reference

The purpose of this class is to wrap all stream handling php functions. More...

Collaboration diagram for ILIAS\Filesystem\Util\PHPStreamFunctions:

Static Public Member Functions
static	ftell ($handle)
	ftell wrapper More...
static	fseek ($stream, int $offset, int $whence)
static	fclose ($handle)
static	fread ($handle, int $length)
static	stream_get_contents ($handle, $length=-1)
static	fwrite ($handle, string $string, ?int $length=null)

Detailed Description

The purpose of this class is to wrap all stream handling php functions.

This allows to mock the functions within unit test which would otherwise require us to redefine the function in a scope which is scanned before the root scope and somehow call the function on our mocks the verify the function calls.

Author

Nicolas Schäfli ns@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 33 of file PHPStreamFunctions.php.

Member Function Documentation

fclose()

static ILIAS\Filesystem\Util\PHPStreamFunctions::fclose (   $handle )

static

Parameters

resource

$handle

See also

fclose()

Definition at line 61 of file PHPStreamFunctions.php.

Referenced by ILIAS\Filesystem\Stream\Stream\close().

                                          : void
    {
        fclose($handle);
    }

Here is the caller graph for this function:

fread()

static ILIAS\Filesystem\Util\PHPStreamFunctions::fread (   $handle, int  $length  )

static

Parameters

resource

$handle

See also

fread()

Definition at line 70 of file PHPStreamFunctions.php.

Referenced by ILIAS\Filesystem\Stream\Stream\read().

                                                      : bool|string
    {
        return fread($handle, $length);
    }

Here is the caller graph for this function:

fseek()

static ILIAS\Filesystem\Util\PHPStreamFunctions::fseek (   $stream, int  $offset, int  $whence  )

static

Parameters

resource

$stream

Returns

int 0 or -1

Definition at line 52 of file PHPStreamFunctions.php.

Referenced by ILIAS\Filesystem\Stream\Stream\seek().

                                                                   : int
    {
        return fseek($stream, $offset, $whence);
    }

Here is the caller graph for this function:

ftell()

static ILIAS\Filesystem\Util\PHPStreamFunctions::ftell (   $handle )

static

ftell wrapper

Parameters

resource

$handle

See also

ftell()

Definition at line 43 of file PHPStreamFunctions.php.

Referenced by ILIAS\Filesystem\Stream\Stream\tell().

                                         : bool|int
    {
        return ftell($handle);
    }

Here is the caller graph for this function:

fwrite()

static ILIAS\Filesystem\Util\PHPStreamFunctions::fwrite (   $handle, string  $string, ?int  $length = null  )

static

Parameters

resource

$handle

See also

fwrite()

Definition at line 89 of file PHPStreamFunctions.php.

Referenced by ILIAS\Filesystem\Stream\StreamTest\testWriteWhichShouldSucceed(), and ILIAS\Filesystem\Stream\Stream\write().

                                                                               : bool|int
    {
        if (is_null($length)) {
            return fwrite($handle, $string);
        }

        return fwrite($handle, $string, $length);
    }

Here is the caller graph for this function:

stream_get_contents()

static ILIAS\Filesystem\Util\PHPStreamFunctions::stream_get_contents (   $handle,   $length = -1  )

static

Parameters

resource

$handle

See also

stream_get_contents()

Definition at line 79 of file PHPStreamFunctions.php.

Referenced by ILIAS\Filesystem\Stream\Stream\getContents().

                                                                     : bool|string
    {
        return stream_get_contents($handle, $length);
    }

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• components/ILIAS/Filesystem/src/Util/PHPStreamFunctions.php