ILIAS\Filesystem\Stream\StreamOptions Class Reference

The streaming options are used by the stream implementation. More...

Collaboration diagram for ILIAS\Filesystem\Stream\StreamOptions:

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

Data Fields
const	UNKNOWN_STREAM_SIZE = -1

Detailed Description

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

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

Definition at line 30 of file StreamOptions.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Filesystem\Stream\StreamOptions::__construct	(	private array	$metadata = [],
		private 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 43 of file StreamOptions.php.

    {
    }

Member Function Documentation

getMetadata()

ILIAS\Filesystem\Stream\StreamOptions::getMetadata

(

)

Returns

\string[]

Definition at line 55 of file StreamOptions.php.

                                 : array
    {
        return $this->metadata;
    }

getSize()

ILIAS\Filesystem\Stream\StreamOptions::getSize

(

)

Definition at line 47 of file StreamOptions.php.

                             : int
    {
        return $this->size;
    }

Field Documentation

UNKNOWN_STREAM_SIZE

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

Definition at line 35 of file StreamOptions.php.

---

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

• components/ILIAS/Filesystem/src/Stream/StreamOptions.php