\
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\Environment Dotenv

Dotenv class.

The Dotenv package is a lightweight utility for managing environment variables in PHP applications. It provides a simple and efficient way to load and access environment-specific configuration from a .env file. Unlike some well-known dotenv packages that are primarily designed for development environments, this package is tailored for production use, ensuring both speed and security by avoiding direct manipulation of $_ENV or $_SERVER by default.

Summary

Methods
Properties
Constants
load
copyVarsToPutenv
copyVarsToEnv
copyVarsToServer
all
get
set
setRequired
flush
No public properties found
No public constants found
checkRequiredVariables
variables
required
isLoaded
No protected constants found
No private methods found
No private properties found
No private constants found

Properties

$variables

$variables : array

Key-value storage.

Type

array<string, string> — Holds an array of the key-value storage.

$required

$required : array

Required variables.

Type

array<int, string> — Holds an array of required variables.

$isLoaded

$isLoaded : bool

Were variables loaded?

Type

bool — Determine which variables is loaded.

Methods

load()

load(string  $directoryPath, string|null  $fileName = null) : void

Load and parse .env file from a given directory.

Parameters

string $directoryPath

Holds the path to the directory containing the .env file.
string|null $fileName

Holds the filename to load. (Optional)

Throws

\Exception

Returns

void —

copyVarsToPutenv()

copyVarsToPutenv(string  $prefix = 'PHP_') : void

Copy all variables to putenv().

Parameters

string $prefix

Holds the variables prefix.

Returns

void —

copyVarsToEnv()

copyVarsToEnv() : void

Copy all variables to $_ENV.

Returns

void —

copyVarsToServer()

copyVarsToServer() : void

Copy all variables to $_SERVER.

Returns

void —

all()

all() : array<string,string>

Get env variables.

Returns

array —

Return an array with all environment variables.

get()

get(string  $key, mixed  $default = null) : mixed

Get env variable.

Parameters

string $key

Holds the environment variable key to retrieve.
mixed $default

Holds the default value to return if the key is not set. Default is null.

Returns

mixed —

Returns the value of the environment variable, or the default value if the key is not found.

set()

set(string|array  $keys, mixed  $value = null) : void

Set an environment variable.

Parameters

string|array $keys

Holds a single variable key or an array of variable keys.
mixed $value

Holds the value for the key, or null if an array of keys is provided.

Throws

\InvalidArgumentException

if the values not are a string.

Returns

void —

setRequired()

setRequired(array  $variables) : void

Set required variables.

Parameters

array $variables

Holds an array of variables.

Returns

void —

flush()

flush() : void

Delete all variables.

Returns

void —

checkRequiredVariables()

checkRequiredVariables() : void

Throw exception if any of required variables was not loaded.

Throws

\Omega\Environment\Exception\MissingVariableException

if the .env variable is missing.

Returns

void —