Contributte

Contributte Bootstrap

github.com/contributte/bootstrap
packagist.org/packages/contributte/bootstrap

# Content

# Setup

composer require contributte/bootstrap
1

# ExtraConfigurator

The ExtraConfigurator extends Configurator and adds a few methods for better usage in containers (Docker).

  • setFileDebugMode($fileName = NULL)
  • setEnvDebugMode()
  • addEnvParameters()

# Debug mode

We added two methods to help you detect the debug mode. You can either manage the debug mode via NETTE_DEBUG environmental variable and detect it this way:

use Contributte\Bootstrap\ExtraConfigurator;

$configurator = new ExtraConfigurator();
$configurator->setEnvDebugMode();
1
2
3
4

or via a file. If no file is supplied as a parameter, it looks for .debug file in the root directory. The sole existence of the file with no content will set the debug mode to TRUE.

use Contributte\Bootstrap\ExtraConfigurator;

$configurator = new ExtraConfigurator();
$configurator->setFileDebugMode(__DIR__ . '/../.debug');
1
2
3
4

Valid values for the ENV variable NETTE_DEBUG and the file are:

# Environment variables

You can now setup your config parameters over environment variables.

Environment variable must follow this pattern: NETTE__{NAME}, NETTE__{NAME}__{NAME2}.

export NETTE__DATABASE__USER=test
export NETTE__DATABASE__HOST=localhost
1
2

Just create your configurator object.

use Contributte\Bootstrap\ExtraConfigurator;

$configurator = new ExtraConfigurator();
$configurator->addEnvParameters();
1
2
3
4

That's all.

# Parse case

By default NETTE__FOO is NETTE__ stripped and FOO is converted to lowercase. You can change it to natural parse case.

For example NETTE_USer=felix will produce:

$configurator->setParseCase($configurator::PARSE_NATURAL); // USer
$configurator->setParseCase($configurator::PARSE_LOWERCASE); // user
$configurator->setParseCase($configurator::PARSE_UPPERCASE); // USER
1
2
3

# Parse delimiter

By default we have __ delimiter. It can be changed to suppor NETTE_FOO or NETTE.FOO.

$configurator->setParseDelimiter('_');
$configurator->setParseDelimiter('.');
1
2

# Helpers

You can also use these static methods for parsing ENV variables and setting the debug mode from the ENV variable.

$configurator->setDebugMode(ExtraConfigurator::parseEnvDebugMode());
$configurator->addParameters(ExtraConfigurator::parseEnvironmentParameters());
$configurator->addParameters(ExtraConfigurator::parseAllEnvironmentParameters());
1
2
3

# PluggableConfigurator

There's a need to organize bulk of codes together, we call them plugins. Official Nette\Configurator does not support any type of plugin, so PluggableConfigurator was created.

use Contributte\Bootstrap\PluggableConfigurator;

$pluggable = new PluggableConfigurator();

$pluggable->addPlugin(new MyBeforeContainerIsLoadedPlugin());
$pluggable->addPlugin(new SpecialOnlyInDebugModePlugin());
1
2
3
4
5
6

You can easilly add a new plugin via addPlugin($plugin) method.

There are some types of plugin.

Plugin Triggers Arguments Mode
IConfigurationPlugin before createContainer Configurator ALL
IContainerPlugin after createContainer Configurator, Container ALL
IDebugContainerPlugin after createContainer Configurator, Container DEBUG
ICompilerPlugin during generateContainer Configurator, Compiler ALL
IDebugCompilerPlugin during generateContainer Configurator, Compiler DEBUG