NativeLocalSourceStream implements SourceStream
FinalYes
Interfaces
Methods
- __construct() : mixed
- close() : void
- content() : string
- isOpen() : bool
- iterate() : Generator<string|int, string>
- open() : self
- path() : Path
- read() : string
- readLines() : Generator<string|int, string>
- size() : null|int
Methods
__construct()
public
__construct(Path $path, resource $handle) : mixed
Parameters
- $path : Path
- $handle : resource
close()
public
close() : void
content()
public
content() : string
Return values
stringisOpen()
public
isOpen() : bool
Return values
booliterate()
public
iterate([int<1, max> $length = 1 ]) : Generator<string|int, string>
Parameters
- $length : int<1, max> = 1
Return values
Generator<string|int, string>open()
public
static open(Path $path) : self
Parameters
- $path : Path
Return values
selfpath()
public
path() : Path
Return values
Pathread()
public
read(int $length, int $offset) : string
Parameters
- $length : int
-
number of bytes to read from the stream
- $offset : int
-
The offset where to start reading from the stream. If negative, reading will start from the end of the stream.
Return values
stringreadLines()
public
readLines([string $separator = "
" ][, int<1, max>|null $length = null ]) : Generator<string|int, string>
Parameters
- $separator : string = " "
-
The line separator, content will be read until the first occurrence of the separator
- $length : int<1, max>|null = null
Return values
Generator<string|int, string>size()
public
size() : null|int
Return values
null|int —The size of the stream in bytes