https://github.com/sjinks/php-ext-dotenv

A PHP extension that sets environment variables from a file on request startup
https://github.com/sjinks/php-ext-dotenv

configuration dotenv env php-extension

Last synced: about 2 months ago
JSON representation

A PHP extension that sets environment variables from a file on request startup

• Host: GitHub
• URL: https://github.com/sjinks/php-ext-dotenv
• Owner: sjinks
• License: mit
• Created: 2021-12-18T02:33:51.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-10-23T19:20:51.000Z (3 months ago)
• Last Synced: 2024-10-24T05:54:09.535Z (3 months ago)
• Topics: configuration, dotenv, env, php-extension
• Language: C
• Homepage:
• Size: 200 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# php-ext-dotenv

[![Build and Test](https://github.com/sjinks/php-ext-dotenv/actions/workflows/test.yml/badge.svg)](https://github.com/sjinks/php-ext-dotenv/actions/workflows/test.yml)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=sjinks_php-ext-dotenv&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=sjinks_php-ext-dotenv)

A PHP extension that sets environment variables from a file on request startup.

## Installation

```bash

phpize

./configure

make

sudo make install

```

## Configuration

| Setting                      | Type    | Mode             | Description                                                                          |

|------------------------------|---------|------------------|--------------------------------------------------------------------------------------|

| `dotenv.file`                | string  | `PHP_INI_PERDIR` | Path to the environment file                                                         |

| `dotenv.overwrite`           | boolean | `PHP_INI_PERDIR` | Whether to overwrite the existing environment variables (`false` by default)         |

| `dotenv.cli.file`            | string  | `PHP_INI_PERDIR` | Name (without path) of the environment file for CLI. If set, overrides `dotenv.file` |

| `dotenv.cli.use_script_dir`  | boolean | `PHP_INI_PERDIR` | If `On` (default), `dotenv.cli.file` will be searched for starting from the running script directory. Otherwise, the current directory will be used as a starting point |

Example:

```ini

dotenv.file = /path/to/my/.env

dotenv.overwrite = On

dotenv.cli.file = .env

dotenv.cli.use_script_dir = Off

```

For CGI and FastCGI, it is possible to set different values for [different hosts and paths](https://www.php.net/manual/en/ini.sections.php):

```ini

[HOST=example.com]

dotenv.file = /path/to/example.com/.env

[HOST=example.org]

dotenv.file = /path/to/example.org/.env

[php]

```

## How It Works

During the request startup, the extension reads the file specified in the `dotenv.file` setting, parses that file, and populates the environment with the keys and values read from the file. The parser is compatible with that of [Node.js `dotenv`](https://www.npmjs.com/package/dotenv) version 10.0 (test cases use the same environment file to test parsing).

During the request shutdown, all the environment variables added or modified by this extension will be removed from the environment.

For the CLI, it is possible to override the name of the environment file. If `dotenv.cli.file` is set, the extension will look for that file by walking up the directory tree starting from either the current directory (when `dotenv.cli.use_script_dir` is `Off`) or from the script directory (`On`).

## API

The extension provides the following functions:

```php

function dotenv_parse_file(string $filename, ?resource $context = null): array

```

The function parses `$filename` as an .env file and returns the parsed variables and their values as an array (`array`).

`$context` is a [context resource](https://www.php.net/manual/en/stream.contexts.php).

Refer to [`fopen()` ](https://www.php.net/manual/en/function.fopen.php) for the detailed description of what `$filename` and `$context` can be.

```php

function dotenv_setenv(array $env, bool $overwrite = ini_get('dotenv.overwrite')): void

```

Sets the environment variables from `$env`; the variables set will be unset during the request shutdown. `$overwrite` controls whether the existing environment variables should be overwritten (if a variable is not overwritten, it will not be unset).

```php

function dotenv_find_file_upward(string $dir, string $file): ?string

```

Searches for file `$file` by walking up the directory tree starting from `$dir` until the file is found or the root is reached.