\
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 StreamMode

Class StreamMode.

This class represents a mode for file streams, encapsulating the logic required to interpret and validate different stream modes. It allows you to check if the mode permits reading, writing, and file operations like opening existing files or creating new ones.

Summary

Methods
Properties
Constants
__construct
getMode
allowsRead
allowsWrite
allowsExistingFileOpening
allowsNewFileOpening
impliesExistingContentDeletion
impliesPositioningCursorAtTheBeginning
impliesPositioningCursorAtTheEnd
isBinary
isText
No public properties found
No public constants found
No protected methods found
No protected properties found
No protected constants found
No private methods found
base
plus
flag
mode
No private constants found

Properties

$base

$base : string

Type

string — The base mode character (r, w, a, etc.)

$plus

$plus : bool

Type

bool — Indicates if the mode includes a '+' character for reading and writing

$flag

$flag : string

Type

string — Additional flags from the mode string (e.g., b for binary)

$mode

$mode : string

Type

string

Methods

__construct()

__construct(string  $mode) : mixed

StreamMode constructor.

Parameters

string $mode

A stream mode string compatible with fopen().

Returns

mixed —

getMode()

getMode() : string

Returns the underlying mode.

Returns

string —

The mode string as provided during construction.

allowsRead()

allowsRead() : bool

Indicates whether the mode allows reading.

Returns

bool —

TRUE if the mode permits reading; otherwise, FALSE.

allowsWrite()

allowsWrite() : bool

Indicates whether the mode allows writing.

Returns

bool —

TRUE if the mode permits writing; otherwise, FALSE.

allowsExistingFileOpening()

allowsExistingFileOpening() : bool

Indicates whether the mode allows opening an existing file.

Returns

bool —

TRUE if the mode permits opening an existing file; otherwise, FALSE.

allowsNewFileOpening()

allowsNewFileOpening() : bool

Indicates whether the mode allows creating a new file.

Returns

bool —

TRUE if the mode permits creating a new file; otherwise, FALSE.

impliesExistingContentDeletion()

impliesExistingContentDeletion() : bool

Indicates whether the mode implies deleting the existing content of the file when it already exists.

Returns

bool —

TRUE if the mode implies content deletion; otherwise, FALSE.

impliesPositioningCursorAtTheBeginning()

impliesPositioningCursorAtTheBeginning() : bool

Indicates whether the mode implies positioning the cursor at the beginning of the file.

Returns

bool —

TRUE if the cursor is positioned at the beginning; otherwise, FALSE.

impliesPositioningCursorAtTheEnd()

impliesPositioningCursorAtTheEnd() : bool

Indicates whether the mode implies positioning the cursor at the end of the file.

Returns

bool —

TRUE if the cursor is positioned at the end; otherwise, FALSE.

isBinary()

isBinary() : bool

Indicates whether the stream is in binary mode.

Returns

bool —

TRUE if the mode is binary; otherwise, FALSE.

isText()

isText() : bool

Indicates whether the stream is in text mode.

Returns

bool —

TRUE if the mode is text; otherwise, FALSE.