MediaWiki  master
MediaWiki\Rest\Stream Class Reference
Inheritance diagram for MediaWiki\Rest\Stream:
Collaboration diagram for MediaWiki\Rest\Stream:

Public Member Functions

 __construct ( $stream, $options=[])
 
 copyToStream ( $target)
 Copy this stream to a specified stream resource. More...
 

Private Attributes

 $stream
 

Detailed Description

Definition at line 7 of file Stream.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Rest\Stream::__construct (   $stream,
  $options = [] 
)

Definition at line 10 of file Stream.php.

References MediaWiki\Rest\Stream\$stream.

Member Function Documentation

◆ copyToStream()

MediaWiki\Rest\Stream::copyToStream (   $stream)

Copy this stream to a specified stream resource.

For some streams, this can be implemented without a tight loop in PHP code.

Equivalent to reading from the object until EOF and writing the resulting data to $stream. The position will be advanced to the end.

Note that $stream is not a StreamInterface object.

Parameters
resource$streamDestination

Implements MediaWiki\Rest\CopyableStreamInterface.

Definition at line 15 of file Stream.php.

Member Data Documentation

◆ $stream

MediaWiki\Rest\Stream::$stream
private

Definition at line 8 of file Stream.php.

Referenced by MediaWiki\Rest\Stream\__construct().


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