Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.3.x will end 7 October 2024 (12 months).
  • Bug fixes for security issues in 4.3.x will end 21 April 2025 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.2.x is supported too.

(no description)

File Size: 45 lines (1 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

StreamFactoryInterface:: (3 methods):
  createStream()
  createStreamFromFile()
  createStreamFromResource()


Interface: StreamFactoryInterface  - X-Ref

createStream(string $content = '')   X-Ref
Create a new stream from a string.

The stream SHOULD be created with a temporary resource.

param: string $content String content with which to populate the stream.
return: StreamInterface

createStreamFromFile(string $filename, string $mode = 'r')   X-Ref
Create a stream from an existing file.

The file MUST be opened using the given mode, which may be any mode
supported by the `fopen` function.

The `$filename` MAY be any string supported by `fopen()`.

param: string $filename Filename or stream URI to use as basis of stream.
param: string $mode Mode with which to open the underlying filename/stream.
return: StreamInterface

createStreamFromResource($resource)   X-Ref
Create a new stream from an existing resource.

The stream MUST be readable and may be writable.

param: resource $resource PHP resource to use as basis of stream.
return: StreamInterface