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

Application Context

, _(*1)

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., _(*2)

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., _(*3)

export APPLICATION_CONTEXT=Development/Local/JohnDoe

if($applicationContext->isDevelopment()) {
    // … do this in development mode only
}

An environment variable sets the context, whichs is retrieved using this class., _(*4)

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., _(*5)

Requirements

• PHP

Installation

Packagist Entry https://packagist.org/packages/pixelbrackets/application-context/, _(*6)

Source

https://gitlab.com/pixelbrackets/application-context/, _(*7)

Mirror https://github.com/pixelbrackets/application-context/, _(*8)

Usage

1. Set the application context using an environment variable, _(*9)

   A context may contain arbitrary sub-contexts. They are delimited with a slash. For example Production/Integration or Development/LocalMachines/JohnDoe., _(*10)

   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., _(*11)

   export APPLICATION_CONTEXT=Development/Local/JohnDoe
   

   or pass to the script like this, _(*12)

   APPLICATION_CONTEXT=Development php index.php
   

   💡 Hint: The package helhum/dotenv-connector lets you store these variables in an .env file and automatically parse it., _(*13)

2. Integrate the ApplicationContext class, _(*14)

   $applicationContext = new \Pixelbrackets\ApplicationContext\ApplicationContext(getenv('APPLICATION_CONTEXT'));
   

   If the context variable is empty, then Production is the default., _(*15)

3. Change code or configuration depending on the given context, _(*16)

   $config['write-logs'] = true;
   $config['mail']['to'] = 'johndoe@example.com';
   if($applicationContext->isDevelopment()) {
      $config['mail']['to'] = 'test-test@localhost.tld';
   }
   

   Available methods to check the top-level context are isProduction(), isTesting() and isDevelopment()., _(*17)

   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., _(*18)

   $configFile = __DIR__ . '/Configuration/' . (string)$applicationContext . '.php';
   if (file_exists($configFile)) {
    require($configFile);
   }
   

License

GNU General Public License version 2 or later, _(*19)

The GNU General Public License can be found at http://www.gnu.org/copyleft/gpl.html., _(*20)

Attributions:, _(*21)

• This library is a standalone version of the Application Context in TYPO3 CMS which derived from the TYPO3 Flow framework.

Author

Dan Untenzu (mail@pixelbrackets.de / @pixelbrackets), _(*22)

Changelog

./CHANGELOG.md, _(*23)

Contribution

This script is Open Source, so please use, patch, extend or fork it., _(*24)