/dotenv

simple dotenv file loader using the PHP built-in parse_ini_file() to efficiently parse dotenv files

Primary LanguagePHPMIT LicenseMIT

dotenv - simple dotenv file loader using the built-in parse_ini_file()

PHP Version Require Latest Stable Version License

Load environment variables from dotenv file using the PHP built-in parse_ini_file() function with scanner mode INI_SCANNER_TYPED (See PHP manual)

It is a simple, reliable and super fast way to load dotenv files without any bells nor whistles.

📔 Go to documentation

Installation

Installation via composer:

composer require tomrf/dotenv

Usage

$dotEnvLoader = new \Tomrf\DotEnv\DotEnvLoader();

// loadImmutable() will not overwrite existing environment variables
$dotEnvLoader->loadImmutable(__DIR__ . '/.env');

// load() will overwrite existing environment variables
$dotEnvLoader->load('/path/to/dotenv/file');

Testing

composer test

License

This project is released under the MIT License (MIT). See LICENSE for more information.

Documentation

📂 Tomrf\DotEnv\DotEnvLoader::class

Simple dotenv loader using parse_ini_file().

load()

Loads dotenv file into local environment, overwriting any environment variable already set.

public function load(
    string $filename
): void

@throws   \Tomrf\DotEnv\DotEnvLoaderException if parsing fails or if the file is not found

loadImmutable()

Loads dotenv file into local environment while preserving any existing environment variable.

public function loadImmutable(
    string $filename
): void

@throws   \Tomrf\DotEnv\DotEnvLoaderException if parsing fails or if the file is not found

Generated 2023-04-21T13:16:14+00:00 using 📚tomrf/readme-gen