ILIAS\Filesystem\Stream\StreamOptions Class Reference

Class StreamOptions. More...

Collaboration diagram for ILIAS\Filesystem\Stream\StreamOptions:

Public Member Functions
	__construct (array $metadata=[], int $size=self::UNKNOWN_STREAM_SIZE)
	StreamOptions constructor. More...
	getSize ()
	getMetadata ()

Data Fields
const	UNKNOWN_STREAM_SIZE = -1

Private Attributes
	$size
	$metadata

Detailed Description

Class StreamOptions.

The streaming options are used by the stream implementation. This class only hold configuration options which can be used by the Stream class.

Author

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

Since

5.3

Version

1.0.0

See also

Stream

Definition at line 19 of file StreamOptions.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Filesystem\Stream\StreamOptions::__construct	(	array	$metadata = [],
		int	$size = self::UNKNOWN_STREAM_SIZE
	)

StreamOptions constructor.

Parameters

\string[]	$metadata	Additional metadata for the stream.
int	$size	The known stream size in byte. -1 indicates an unknown size.

Definition at line 39 of file StreamOptions.php.

    {
        $this->size = $size;
        $this->metadata = $metadata;
    }

References ILIAS\Filesystem\Stream\StreamOptions\$metadata, and ILIAS\Filesystem\Stream\StreamOptions\$size.

Member Function Documentation

getMetadata()

ILIAS\Filesystem\Stream\StreamOptions::getMetadata

(

)

Returns

\string[]

Definition at line 58 of file StreamOptions.php.

                                  : array
    {
        return $this->metadata;
    }

References ILIAS\Filesystem\Stream\StreamOptions\$metadata.

getSize()

ILIAS\Filesystem\Stream\StreamOptions::getSize

(

)

Returns

int

Definition at line 49 of file StreamOptions.php.

                              : int
    {
        return $this->size;
    }

References ILIAS\Filesystem\Stream\StreamOptions\$size.

Field Documentation

$metadata

string[] ILIAS\Filesystem\Stream\StreamOptions::$metadata

private

Definition at line 30 of file StreamOptions.php.

Referenced by ILIAS\Filesystem\Stream\StreamOptions\__construct(), and ILIAS\Filesystem\Stream\StreamOptions\getMetadata().

$size

int ILIAS\Filesystem\Stream\StreamOptions::$size

private

Definition at line 26 of file StreamOptions.php.

Referenced by ILIAS\Filesystem\Stream\StreamOptions\__construct(), and ILIAS\Filesystem\Stream\StreamOptions\getSize().

UNKNOWN_STREAM_SIZE

const ILIAS\Filesystem\Stream\StreamOptions::UNKNOWN_STREAM_SIZE = -1

Definition at line 21 of file StreamOptions.php.

---

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

• src/Filesystem/Stream/StreamOptions.php