\
Omega
Application
Archive
Cache
Adapter
Exception
Factory
ServiceProvider
Config
ServiceProvider
Container
Exception
ServiceProvider
Database
Adapter
Command
Exception
Factory
Migration
Field
QueryBuilder
ServiceProvider
Environment
Command
Exception
Exceptions
Filesystem
Adapter
Amazon
Ftp
Local
Memory
Sftp
Contracts
Exception
Factory
ServiceProvider
Stream
Util
Http
ServiceProvider
Logging
Exception
Factory
ServiceProvider
Queue
Adapter
Command
Exception
Factory
ServiceProvider
Routing
ServiceProvider
Session
Exception
Factory
ServiceProvider
Storage
Support
Facade
Exception
Facades
Factory
Singleton
Exception
Validation
Exception
Rule
ServiceProvider
View
Engine
ServiceProvider

\Omega\Filesystem\Stream Local

Local stream class for file handling.

This class provides an interface for reading from and writing to local file streams. It manages the file handle and supports various stream operations such as opening, reading, writing, seeking, and flushing. It also ensures that directories are created as needed when writing to a file.

Summary

Methods
Properties
Constants
__construct
open
read
write
close
flush
seek
tell
eof
stat
cast
unlink
No public properties found
No public constants found
No protected methods found
No protected properties found
No protected constants found
No private methods found
mode
fileHandle
path
mkdirMode
No private constants found

Properties

$mode

$mode : \Omega\Filesystem\Stream\StreamMode|null

Type

StreamMode|null — The current mode of the stream (e.g., read, write).

$fileHandle

$fileHandle : mixed

Type

mixed — The file handle resource used for stream operations.

$path

$path : string

Type

string

$mkdirMode

$mkdirMode : int

Type

int

Methods

__construct()

__construct(string  $path, int  $mkdirMode = 0755) : mixed

Constructs a Local stream instance.

Parameters

string $path

The path to the file.
int $mkdirMode

The mode to use when creating directories (default is 0755).

Returns

mixed —

open()

open(\Omega\Filesystem\Stream\StreamMode  $mode) : bool

Opens the stream in the specified mode.

Parameters

\Omega\Filesystem\Stream\StreamMode $mode

The mode in which to open the stream.

Returns

bool —

TRUE on success, or FALSE on failure.

read()

read(int  $count) : string|false

Reads the specified number of bytes from the current position.

Parameters

int $count

The number of bytes to read from the stream.

Returns

string|false —

The read bytes as a string, or FALSE on failure.

write()

write(string  $data) : int|false

Writes the specified data to the stream.

Parameters

string $data

The data to write to the stream.

Returns

int|false —

The number of bytes that were successfully written, or FALSE on failure.

close()

close() : bool

Closes the stream.

Returns

bool —

TRUE on success, or FALSE on failure.

flush()

flush() : bool

Flushes the output buffer.

Returns

bool —

TRUE on success, or FALSE on failure.

seek()

seek(int  $offset, int  $whence = SEEK_SET) : bool

Seeks to the specified offset within the stream.

Parameters

int $offset

The offset to seek to.
int $whence

The reference point for the offset (default is SEEK_SET).

Returns

bool —

TRUE on success, or FALSE on failure.

tell()

tell() : int|false

Returns the current position of the stream.

Returns

int|false —

The current position as an integer, or FALSE on failure.

eof()

eof() : bool

Indicates whether the current position is at the end-of-file.

Returns

bool —

TRUE if at end-of-file, FALSE otherwise.

stat()

stat() : array|false

Gathers statistics about the stream.

Returns

array|false —

An associative array of stream statistics, or FALSE on failure.

cast()

cast(int  $castAs) : mixed

Retrieves the underlying resource associated with the stream.

Parameters

int $castAs

An optional parameter to cast the resource as a specific type.

Returns

mixed —

The underlying resource or FALSE on failure.

unlink()

unlink() : bool

Deletes the file associated with the stream.

Returns

bool —

TRUE on success, or FALSE otherwise.