Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
GuzzleHttp\Psr7\Stream Class Reference
Inheritance diagram for GuzzleHttp\Psr7\Stream:
Psr\Http\Message\StreamInterface

Public Member Functions

 __construct ($stream, array $options=[])
 This constructor accepts an associative array of options.
 
 __destruct ()
 Closes the stream when the destructed.
 
 __toString ()
 Reads all data from the stream into a string, from the beginning to end.
 
 close ()
 Closes the stream and any underlying resources.
 
 detach ()
 Separates any underlying resources from the stream.
 
 eof ()
 Returns true if the stream is at the end of the stream.
 
 getContents ()
 Returns the remaining contents in a string.
 
 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.@externalurl http://php.net/manual/en/function.stream-get-meta-data.php

Parameters
string$keySpecific metadata to retrieve.
Return values
array|mixed|nullReturns 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.
}
 
 getSize ()
 Get the size of the stream if known.
 
 isReadable ()
 Returns whether or not the stream is readable.
 
 isSeekable ()
 Returns whether or not the stream is seekable.
 
 isWritable ()
 Returns whether or not the stream is writable.
 
 read ($length)
 Read data from the stream.
 
 rewind ()
 Seek to the beginning of the stream.
 
 seek ($offset, $whence=SEEK_SET)
 Seek to a position in the stream.
 
 tell ()
 Returns the current position of the file read/write pointer.
 
 write ($string)
 Write data to the stream.
 

Constructor & Destructor Documentation

◆ __construct()

GuzzleHttp\Psr7\Stream::__construct ( $stream,
array $options = [] )

This constructor accepts an associative array of options.

  • size: (int) If a read stream would otherwise have an indeterminate size, but the size is known due to foreknowledge, then you can provide that size, in bytes.
  • metadata: (array) Any additional metadata to return when the metadata of the stream is accessed.
Parameters
resource$streamStream resource to wrap.
array{size?int, metadata?: array} $options Associative array of options.
Exceptions
InvalidArgumentExceptionif the stream is not a stream resource

Member Function Documentation

◆ __toString()

GuzzleHttp\Psr7\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
Return values
string

Implements Psr\Http\Message\StreamInterface.

◆ close()

GuzzleHttp\Psr7\Stream::close ( )

Closes the stream and any underlying resources.

Return values
void

Implements Psr\Http\Message\StreamInterface.

◆ detach()

GuzzleHttp\Psr7\Stream::detach ( )

Separates any underlying resources from the stream.

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

Return values
resource|nullUnderlying PHP stream, if any

Implements Psr\Http\Message\StreamInterface.

◆ eof()

GuzzleHttp\Psr7\Stream::eof ( )

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

Return values
bool

Implements Psr\Http\Message\StreamInterface.

◆ getContents()

GuzzleHttp\Psr7\Stream::getContents ( )

Returns the remaining contents in a string.

Return values
string
Exceptions
RuntimeExceptionif unable to read or an error occurs while reading.

Implements Psr\Http\Message\StreamInterface.

◆ getMetadata()

GuzzleHttp\Psr7\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.@externalurl http://php.net/manual/en/function.stream-get-meta-data.php

Parameters
string$keySpecific metadata to retrieve.
Return values
array|mixed|nullReturns 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.
}

Return values
mixed

Implements Psr\Http\Message\StreamInterface.

◆ getSize()

GuzzleHttp\Psr7\Stream::getSize ( )

Get the size of the stream if known.

Return values
int|nullReturns the size in bytes if known, or null if unknown.

Implements Psr\Http\Message\StreamInterface.

◆ isReadable()

GuzzleHttp\Psr7\Stream::isReadable ( )

Returns whether or not the stream is readable.

Return values
bool

Implements Psr\Http\Message\StreamInterface.

◆ isSeekable()

GuzzleHttp\Psr7\Stream::isSeekable ( )

Returns whether or not the stream is seekable.

Return values
bool

Implements Psr\Http\Message\StreamInterface.

◆ isWritable()

GuzzleHttp\Psr7\Stream::isWritable ( )

Returns whether or not the stream is writable.

Return values
bool

Implements Psr\Http\Message\StreamInterface.

◆ read()

GuzzleHttp\Psr7\Stream::read ( $length)

Read data from the stream.

Parameters
int$lengthRead up to $length bytes from the object and return them. Fewer than $length bytes may be returned if underlying stream call returns fewer bytes.
Return values
stringReturns the data read from the stream, or an empty string if no bytes are available.
Exceptions
RuntimeExceptionif an error occurs.

Implements Psr\Http\Message\StreamInterface.

◆ rewind()

GuzzleHttp\Psr7\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() @externalurl http://www.php.net/manual/en/function.fseek.php
Exceptions
RuntimeExceptionon failure.

Implements Psr\Http\Message\StreamInterface.

◆ seek()

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

Seek to a position in the stream.

@externalurl http://www.php.net/manual/en/function.fseek.php

Parameters
int$offsetStream offset
int$whenceSpecifies 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.
Exceptions
RuntimeExceptionon failure.

Implements Psr\Http\Message\StreamInterface.

◆ tell()

GuzzleHttp\Psr7\Stream::tell ( )

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

Return values
intPosition of the file pointer
Exceptions
RuntimeExceptionon error.

Implements Psr\Http\Message\StreamInterface.

◆ write()

GuzzleHttp\Psr7\Stream::write ( $string)

Write data to the stream.

Parameters
string$stringThe string that is to be written.
Return values
intReturns the number of bytes written to the stream.
Exceptions
RuntimeExceptionon failure.

Implements Psr\Http\Message\StreamInterface.


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