https://github.com/ghostwriter/environment

Provides Environment Variables derived from `$_ENV` and `$_SERVER` super-globals
https://github.com/ghostwriter/environment

environment environment-variables ghostwriter php

Last synced: about 1 month ago
JSON representation

Provides Environment Variables derived from `$_ENV` and `$_SERVER` super-globals

• Host: GitHub
• URL: https://github.com/ghostwriter/environment
• Owner: ghostwriter
• License: bsd-3-clause
• Created: 2022-07-06T17:05:34.000Z (over 2 years ago)
• Default Branch: 2.0.x
• Last Pushed: 2024-08-31T20:30:54.000Z (3 months ago)
• Last Synced: 2024-10-03T10:57:04.192Z (about 2 months ago)
• Topics: environment, environment-variables, ghostwriter, php
• Language: PHP
• Homepage:
• Size: 594 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Environment

[![Automation](https://github.com/ghostwriter/environment/actions/workflows/automation.yml/badge.svg)](https://github.com/ghostwriter/environment/actions/workflows/automation.yml)

[![Supported PHP Version](https://badgen.net/packagist/php/ghostwriter/environment?color=8892bf)](https://www.php.net/supported-versions)

[![Mutation Coverage](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fghostwriter%2Fenvironment%2Fmain)](https://dashboard.stryker-mutator.io/reports/github.com/ghostwriter/environment/main)

[![Code Coverage](https://codecov.io/gh/ghostwriter/environment/branch/main/graph/badge.svg)](https://codecov.io/gh/ghostwriter/environment)

[![Type Coverage](https://shepherd.dev/github/ghostwriter/environment/coverage.svg)](https://shepherd.dev/github/ghostwriter/environment)

[![Latest Version on Packagist](https://badgen.net/packagist/v/ghostwriter/environment)](https://packagist.org/packages/ghostwriter/environment)

[![Downloads](https://badgen.net/packagist/dt/ghostwriter/environment?color=blue)](https://packagist.org/packages/ghostwriter/environment)

Provides Environment Variables derived from `$_ENV` and `$_SERVER` super-globals

## Installation

You can install the package via composer:

``` bash

composer require ghostwriter/environment

```

## Usage

```php

$environment = new \Ghostwriter\Environment\Environment();

$environment->has('APP_ENV'); // false

$environment->get('APP_ENV', 'dev'); // dev

$environment->get('APP_ENV'); // throws NotFoundException

$environment->set('APP_ENV', 'production');

$environment->has('APP_ENV'); // true

$environment->get('APP_ENV'); // production

$environment->unset('APP_ENV');

$environment->set('APP_KEY', 'secrete');

$environment->has('APP_KEY'); // true

$environment->get('APP_KEY'); // secrete

$environment->unset('APP_KEY');

$environment->has('APP_KEY'); // false

$environment->get('APP_KEY', 'fallback-value'); // fallback-value

$environment->get('APP_KEY'); // throws NotFoundException

```

## API

```php

interface Variables extends Countable, IteratorAggregate

{

    public function count(): int;

    public function get(string $name, string|null $default = null): string;

    /**

     * @return Generator

     */

    public function getIterator(): Generator;

    public function has(string $name): bool;

    public function set(string $name, string $value): void;

    /**

     * @return non-empty-array

     */

    public function toArray(): array;

    public function unset(string $name): void;

}

```

## Testing

``` bash

composer test

```

## Changelog

Please see [CHANGELOG.md](./CHANGELOG.md) for more information what has changed recently.

## Security

If you discover any security related issues, please email `[email protected]` instead of using the issue tracker.

## Sponsors

[[`Become a GitHub Sponsor`](https://github.com/sponsors/ghostwriter)]

## Credits

- [Nathanael Esayeas](https://github.com/ghostwriter)

- [All Contributors](https://github.com/ghostwriter/environment/contributors)

## License

The BSD-3-Clause. Please see [License File](./LICENSE) for more information.