https://github.com/quillstack/dotenv

The library to use .env files in your project.
https://github.com/quillstack/dotenv

dotenv env environment php php8 quillstack

Last synced: about 2 months ago
JSON representation

The library to use .env files in your project.

• Host: GitHub
• URL: https://github.com/quillstack/dotenv
• Owner: quillstack
• License: mit
• Created: 2020-10-12T20:54:06.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2022-01-14T10:07:52.000Z (almost 3 years ago)
• Last Synced: 2024-10-13T04:41:18.185Z (3 months ago)
• Topics: dotenv, env, environment, php, php8, quillstack
• Language: PHP
• Homepage: https://quillstack.org/dotenv
• Size: 37.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Quillstack Dotenv

[![Build Status](https://app.travis-ci.com/quillstack/dotenv.svg?branch=main)](https://app.travis-ci.com/quillstack/dotenv)

[![Downloads](https://img.shields.io/packagist/dt/quillstack/dotenv.svg)](https://packagist.org/packages/quillstack/dotenv)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=quillstack_dotenv&metric=coverage)](https://sonarcloud.io/dashboard?id=quillstack_dotenv)

[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=quillstack_dotenv&metric=ncloc)](https://sonarcloud.io/dashboard?id=quillstack_dotenv)

[![StyleCI](https://github.styleci.io/repos/303510748/shield?branch=main)](https://github.styleci.io/repos/303510748?branch=main)

[![CodeFactor](https://www.codefactor.io/repository/github/quillstack/dotenv/badge)](https://www.codefactor.io/repository/github/quillstack/dotenv)

![Packagist License](https://img.shields.io/packagist/l/quillstack/dotenv)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=quillstack_dotenv&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=quillstack_dotenv)

[![Maintainability](https://api.codeclimate.com/v1/badges/df220a266c66f5b4c19c/maintainability)](https://codeclimate.com/github/quillstack/dotenv/maintainability)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=quillstack_dotenv&metric=security_rating)](https://sonarcloud.io/dashboard?id=quillstack_dotenv)

![Packagist PHP Version Support](https://img.shields.io/packagist/php-v/quillstack/dotenv)

The library for using `.env` files. You can find the full documentation on the website: \

https://quillstack.org/dotenv

The `.env` should be used for sensitive information like passwords, hosts, keys, credentials, and all other values that 

can be changed depending on the environment, e.g., debug mode settings or logs level. 

### Installation

To install this package, run the standard command using _Composer_:

```shell

composer require quillstack/dotenv

```

### Usage

You can use Quillstack Dotenv package when you want to use `.env` files in your project.

#### Simple usage

If you created the `.env` file in the root directory of your proejct:

```shell

APP_DEBUG=true

```

You can load this `.env` file in your application:

```php

$dotenv = new Dotenv('.env');

$dotenv->load();

```

Every time you need to know if your application works in debug mode, you can check it using this helper function:

```php

if (env('APP_DEBUG')) {

    echo 'Debug mode';

}

```

#### Default values

You can also define a default value depending on the context:

```php

if (env('APP_DEBUG', false)) {

    echo 'Debug mode';

}

```

#### Required keys

You can use another helper method for required keys. If required key is not found

an exception will be thrown:

```php

$dbHost = required('DATABASE_HOST');

```

The result if the key `DATABASE_HOST` is not set in the `.env` file:

```text

DotenvValueNotSetException:

Value not set for key: DATABASE_HOST

```

#### Multi-line values

You can define multi-line values in your `.env` file by using `\n` separator instead of new lines for example:

```text

PRIVATE_KEY="line1\nline2\nline3"

```

### Unit tests

Run tests using a command:

```shell

phpdbg -qrr ./vendor/bin/unit-tests

```

### Docker

```shell

$ docker-compose up -d

$ docker exec -w /var/www/html -it quillstack_dotenv sh

```