ZipStream\Stream Class Reference

Describes a data stream. More...

Inheritance diagram for ZipStream\Stream:

Collaboration diagram for ZipStream\Stream:

Public Member Functions
	__construct ($stream)
	close ()
	Closes the stream and any underlying resources. More...
	detach ()
	Separates any underlying resources from the stream. More...
	__toString ()
	Reads all data from the stream into a string, from the beginning to end. More...
	seek ($offset, $whence=SEEK_SET)
	Seek to a position in the stream. More...
	isSeekable ()
	Returns whether or not the stream is seekable. More...
	getMetadata ($key=null)
	Get stream metadata as an associative array or retrieve a specific key. More...
	getSize ()
	Get the size of the stream if known. More...
	tell ()
	Returns the current position of the file read/write pointer. More...
	eof ()
	Returns true if the stream is at the end of the stream. More...
	rewind ()
	Seek to the beginning of the stream. More...
	write ($string)
	Write data to the stream. More...
	isWritable ()
	Returns whether or not the stream is writable. More...
	read ($length)
	Read data from the stream. More...
	isReadable ()
	Returns whether or not the stream is readable. More...
	getContents ()
	Returns the remaining contents in a string. More...

Protected Attributes
	$stream

Detailed Description

Describes a data stream.

Typically, an instance will wrap a PHP stream; this interface provides a wrapper around the most common operations, including serialization of the entire stream to a string.

Definition at line 16 of file Stream.php.

Constructor & Destructor Documentation

__construct()

ZipStream\Stream::__construct

(

$stream

)

Definition at line 20 of file Stream.php.

References GuzzleHttp\Psr7\$stream.

    {
        $this->stream = $stream;
    }

Member Function Documentation

__toString()

ZipStream\Stream::__toString

(

)

Reads all data from the stream into a string, from the beginning to end.

This method MUST attempt to seek to the beginning of the stream before reading data and read the stream until the end is reached.

Warning: This could attempt to load a large amount of data into memory.

This method MUST NOT raise an exception in order to conform with PHP's string casting operations.

See also

http://php.net/manual/en/language.oop5.magic.php#object.tostring

Returns

string

Implements Psr\Http\Message\StreamInterface.

Definition at line 66 of file Stream.php.

                                : string
    {
        try {
            $this->seek(0);
        } catch (\RuntimeException $e) {}
        return (string) stream_get_contents($this->stream);
    }

close()

ZipStream\Stream::close

(

)

Closes the stream and any underlying resources.

Returns

void

Implements Psr\Http\Message\StreamInterface.

Definition at line 30 of file Stream.php.

                           : void
    {
        if (is_resource($this->stream)) {
            fclose($this->stream);
        }
        $this->detach();
    }

detach()

ZipStream\Stream::detach

(

)

Separates any underlying resources from the stream.

After the stream has been detached, the stream is in an unusable state.

Returns

resource|null Underlying PHP stream, if any

Implements Psr\Http\Message\StreamInterface.

Definition at line 45 of file Stream.php.

References $result, and GuzzleHttp\Psr7\$stream.

    {
        $result = $this->stream;
        $this->stream = null;
        return $result;
    }

eof()

ZipStream\Stream::eof

(

)

Returns true if the stream is at the end of the stream.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 155 of file Stream.php.

                         : bool
    {
        return feof($this->stream);
    }

getContents()

ZipStream\Stream::getContents

(

)

Returns the remaining contents in a string.

Returns

string

Exceptions

Implements Psr\Http\Message\StreamInterface.

Definition at line 242 of file Stream.php.

References $result.

                                 : string
    {
        if (!$this->isReadable()) {
            throw new RuntimeException;
        }
        $result = stream_get_contents($this->stream);
        if ($result === false) {
            throw new RuntimeException;
        }
        return $result;
    }

getMetadata()

ZipStream\Stream::getMetadata

(

$key = null

)

Get stream metadata as an associative array or retrieve a specific key.

The keys returned are identical to the keys returned from PHP's stream_get_meta_data() function.

string $key Specific metadata to retrieve. array|mixed|null Returns an associative array if no key is provided. Returns a specific key value if a key is provided and the value is found, or null if the key is not found.

Implements Psr\Http\Message\StreamInterface.

Definition at line 118 of file Stream.php.

References $key, and $metadata.

    {
        $metadata = stream_get_meta_data($this->stream);
        return $key !== null ? @$metadata[$key] : $metadata;
    }

getSize()

ZipStream\Stream::getSize

(

)

Get the size of the stream if known.

Returns

int|null Returns the size in bytes if known, or null if unknown.

Implements Psr\Http\Message\StreamInterface.

Definition at line 129 of file Stream.php.

References Sabre\VObject\$stats.

                             : ?int
    {
        $stats = fstat($this->stream);
        return $stats['size'];
    }

isReadable()

ZipStream\Stream::isReadable

(

)

Returns whether or not the stream is readable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 230 of file Stream.php.

                                : bool
    {
        return preg_match('/[r+]/', $this->getMetadata('mode')) === 1;
    }

isSeekable()

ZipStream\Stream::isSeekable

(

)

Returns whether or not the stream is seekable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 101 of file Stream.php.

                                : bool
    {
        return (bool)$this->getMetadata('seekable');
    }

isWritable()

ZipStream\Stream::isWritable

(

)

Returns whether or not the stream is writable.

Returns

bool

Implements Psr\Http\Message\StreamInterface.

Definition at line 198 of file Stream.php.

                                : bool
    {
        return preg_match('/[waxc+]/', $this->getMetadata('mode')) === 1;
    }

read()

ZipStream\Stream::read

(

$length

)

Read data from the stream.

Parameters

int

$length

Read up to $length bytes from the object and return them. Fewer than $length bytes may be returned if underlying stream call returns fewer bytes.

Returns

string Returns the data read from the stream, or an empty string if no bytes are available.

Exceptions

Implements Psr\Http\Message\StreamInterface.

Definition at line 213 of file Stream.php.

References $result.

                                 : string
    {
        if (!$this->isReadable()) {
            throw new RuntimeException;
        }
        $result = fread($this->stream, $length);
        if ($result === false) {
            throw new RuntimeException;
        }
        return $result;
    }

rewind()

ZipStream\Stream::rewind

(

)

Seek to the beginning of the stream.

If the stream is not seekable, this method will raise an exception; otherwise, it will perform a seek(0).

See also

seek() on failure.

Implements Psr\Http\Message\StreamInterface.

Definition at line 170 of file Stream.php.

                            : void
    {
        $this->seek(0);
    }

seek()

ZipStream\Stream::seek	(		$offset,
			$whence = SEEK_SET
	)

Seek to a position in the stream.

int $offset Stream offset int $whence Specifies how the cursor position will be calculated based on the seek offset. Valid values are identical to the built-in PHP $whence values for fseek(). SEEK_SET: Set position equal to offset bytes SEEK_CUR: Set position to current location plus offset SEEK_END: Set position to end-of-stream plus offset. on failure.

Implements Psr\Http\Message\StreamInterface.

Definition at line 86 of file Stream.php.

                                                     : void
    {
        if (!$this->isSeekable()) {
            throw new RuntimeException;
        }
        if (fseek($this->stream, $offset, $whence) !== 0) {
            throw new RuntimeException;
        }
    }

tell()

ZipStream\Stream::tell

(

)

Returns the current position of the file read/write pointer.

Returns

int Position of the file pointer

Exceptions

Implements Psr\Http\Message\StreamInterface.

Definition at line 141 of file Stream.php.

                          : int
    {
        $position = ftell($this->stream);
        if ($position === false) {
            throw new RuntimeException;
        }
        return $position;
    }

write()

ZipStream\Stream::write

(

$string

)

Write data to the stream.

Parameters

string

$string

The string that is to be written.

Returns

int Returns the number of bytes written to the stream.

Exceptions

Implements Psr\Http\Message\StreamInterface.

Definition at line 182 of file Stream.php.

                                  : int
    {
        if (!$this->isWritable()) {
            throw new RuntimeException;
        }
        if (fwrite($this->stream, $string) === false) {
            throw new RuntimeException;
        }
        return \mb_strlen($string);
    }

Field Documentation

$stream

ZipStream\Stream::$stream

protected

Definition at line 18 of file Stream.php.

---

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

• libs/composer/vendor/maennchen/zipstream-php/src/Stream.php