Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pixelbrackets/application-context
Define the context of the current enviroment, in order to adapt configuration options depending on the stage an app is running on
https://github.com/pixelbrackets/application-context
application-context configuration env environment php stages
Last synced: about 2 months ago
JSON representation
Define the context of the current enviroment, in order to adapt configuration options depending on the stage an app is running on
- Host: GitHub
- URL: https://github.com/pixelbrackets/application-context
- Owner: pixelbrackets
- Created: 2018-03-21T13:37:04.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-05-06T11:50:07.000Z (over 4 years ago)
- Last Synced: 2024-10-13T11:09:11.943Z (3 months ago)
- Topics: application-context, configuration, env, environment, php, stages
- Language: PHP
- Homepage: https://gitlab.com/pixelbrackets/application-context/
- Size: 9.77 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Application Context
[](https://packagist.org/packages/pixelbrackets/application-context/)
[](https://gitlab.com/pixelbrackets/application-context/pipelines)
[](https://gitlab.com/pixelbrackets/application-context#requirements)
[](https://spdx.org/licenses/GPL-2.0-or-later.html)
The »Application Context« library allows to define the context of the current
environment, in order to adapt configuration options depending on the stage
an app is running on.
For example if an application is running in `Production` mode, it should
send mails and not create any log files. In `Development` mode however it
should send mails, but to a different recipient, and create excessive log files.
```bash
export APPLICATION_CONTEXT=Development/Local/JohnDoe
```
```php
if($applicationContext->isDevelopment()) {
// … do this in development mode only
}
```
[An environment variable sets the context](https://12factor.net/config),
whichs is retrieved using this class.
The main advantage of this approach is, that the code may stay the same on all
stages, but only configuration values may change, depending on the context.
## Requirements
- PHP
## Installation
Packagist Entry https://packagist.org/packages/pixelbrackets/application-context/
## Source
https://gitlab.com/pixelbrackets/application-context/
Mirror https://github.com/pixelbrackets/application-context/
## Usage
1. Set the application context using an environment variable
A context may contain arbitrary sub-contexts. They are delimited with
a slash. For example `Production/Integration` or
`Development/LocalMachines/JohnDoe`.
The top-level contexts however, must be one of `Development`, `Testing`
or `Production`. `Testing` should be used to run unit tests only.
Use `Production` and `Development` and any sub-context for all stages.
```bash
export APPLICATION_CONTEXT=Development/Local/JohnDoe
```
or pass to the script like this
```bash
APPLICATION_CONTEXT=Development php index.php
```
💡 Hint: The package [helhum/dotenv-connector](https://packagist.org/packages/helhum/dotenv-connector)
lets you store these variables in an `.env` file and automatically parse it.
1. Integrate the `ApplicationContext` class
```php
$applicationContext = new \Pixelbrackets\ApplicationContext\ApplicationContext(getenv('APPLICATION_CONTEXT'));
```
If the context variable is empty, then `Production` is the default.
1. Change code or configuration depending on the given context
```php
$config['write-logs'] = true;
$config['mail']['to'] = '[email protected]';
if($applicationContext->isDevelopment()) {
$config['mail']['to'] = '[email protected]';
}
```
Available methods to check the top-level context are `isProduction()`,
`isTesting()` and `isDevelopment()`.
If the context object is casted to a string, then the return value is the
context string as set in the environment variable. This may be used to load
different files as in this example.
```php
$configFile = __DIR__ . '/Configuration/' . (string)$applicationContext . '.php';
if (file_exists($configFile)) {
require($configFile);
}
```
## License
GNU General Public License version 2 or later
The GNU General Public License can be found at http://www.gnu.org/copyleft/gpl.html.
Attributions:
* This library is a standalone version of the Application Context in TYPO3 CMS
which derived from the TYPO3 Flow framework.
## Author
Dan Untenzu ( / [@pixelbrackets](https://pixelbrackets.de))
## Changelog
[./CHANGELOG.md](./CHANGELOG.md)
## Contribution
This script is Open Source, so please use, patch, extend or fork it.