Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adhocore/php-env
A small and fast .env loader for PHP
https://github.com/adhocore/php-env
adhocore dotenv dotenv-parser env env-loader environment-variables hacktoberfest php-dotenv php-env
Last synced: 2 months ago
JSON representation
A small and fast .env loader for PHP
- Host: GitHub
- URL: https://github.com/adhocore/php-env
- Owner: adhocore
- License: mit
- Created: 2017-10-20T18:55:09.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2023-03-25T14:33:21.000Z (over 1 year ago)
- Last Synced: 2024-05-01T22:54:18.754Z (8 months ago)
- Topics: adhocore, dotenv, dotenv-parser, env, env-loader, environment-variables, hacktoberfest, php-dotenv, php-env
- Language: PHP
- Homepage:
- Size: 44.9 KB
- Stars: 23
- Watchers: 5
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## adhocore/env
[](https://github.com/adhocore/php-env/releases)
[](https://travis-ci.org/adhocore/php-env?branch=master)
[](https://scrutinizer-ci.com/g/adhocore/php-env/?branch=master)
[](https://codecov.io/gh/adhocore/php-env)
[](https://styleci.io/repos/107715208)
[](LICENSE)
- Environment variable loader and retriever for PHP.
- Sanitization/Filters can be applied on retrieval if `filter` extension is loaded.
- Using env to configure application is one of the [12 postulates](https://12factor.net/config).
## Installation
```
composer require adhocore/env
```
## Usage
### Loading
```php
use Ahc\Env\Loader;
// Load env variables from .env file to `putenv` by default:
(new Loader)->load('/project/root/.env');
// Pass in boolean second param to control if the env should be reloaded:
(new Loader)->load('/project/root/.env', true);
// Load to $_SERVER global:
(new Loader)->load('/project/root/.env', true, Loader::SERVER);
// Load to $_ENV global and putenv():
(new Loader)->load('/project/root/.env', true, Loader::ENV | Loader::PUTENV);
// Load to all targets:
(new Loader)->load('/project/root/.env', true, Loader::ALL);
```
> Always wrap complex values within double quotes in `.env` file. Eg: `APP_KEY="K&^¢*&D(?<µ}^(P\]X"`
### ENV Format
Supports `#` or `;` comments. Literal double quote should be escaped like `""`. See more examples below:
```
# comment line
a=1
b="2"
c=$3#
; also comment line
d="lol"
# empty
e=
# f is `"6"`
f=""6""
1_2=one_two
# empty too
E=""
A_B=Apple Ball
x=Y
```
Reference is possible like so:
```
MAIN=1
REF=${MAIN}/2
REF2=${REF}/3
# below will not be parsed as INV is not resolved
REF3=${INV}
```
### Retrieving
```php
use Ahc\Env\Retriever;
// Retrieve:
echo Retriever::getEnv($key);
// Default value:
echo Retriever::getEnv('PAYMENT_GATEWAY', 'stripe');
// Sanitization (pass third and optionally fourth parameters):
echo Retriever::getEnv('MYSQL_PORT', 3306, FILTER_VALIDATE_INT);
// Or you can use `env()` which is alias of `Retriever::getEnv()`:
echo env('THE_KEY');
```
See [filter_var](http://php.net/filter_var) for more on sanitizing/filtering values!
## Benchmark
If you are interested [here](https://github.com/adhocore/env-bench) is a simple benchmark.
---
### Consideration
By default this library only loads env to `putenv()`.
Be cautious exposing confidential credentials into `$_ENV` and `$_SERVER` which bug/error catchers may log.
Although this libray is already fast enough, in production you might want to boost performance a little by loading if only required:
```php
if (!getenv('')) {
// Override false :)
(new Loader)->load('/project/root/.env', false);
}
```
For example if your app last introduced `FB_APP_ID` env, but this value is not already hard set in the machine,
it would be loaded via `.env` file else you are already covered.
### Credits
This project is [release](https://github.com/adhocore/php-env/releases)
managed by [please](https://github.com/adhocore/please).