Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feature #28976 [DI] Add a "default" EnvProcessor (jderusse)
This PR was squashed before being merged into the 4.3-dev branch (closes #28976). Discussion ---------- [DI] Add a "default" EnvProcessor | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | - | License | MIT | Doc PR | TODO This PR add a new fallback env processor in order to return a default value when the primary processor is not able to fetch a value (env variable, file or key does not exists) ``` # default_host: localhost host: '%env(default:default_host:OPTIONAL_ENV_VARIABLE)%" default_secret: this secret is not secret secret: '%env(default:default_secret:file:THIS_FILE_ONLY_EXIST_IN_PRODUCTION)%" default_charset: utf8 charset: '%env(default:default_charset:key:charset:json:DATABASE_CONFIG)%" ``` Commits ------- aee4e33 [DI] Add a \"default\" EnvProcessor
- Loading branch information
Showing
7 changed files
with
186 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
130 changes: 130 additions & 0 deletions
130
src/Symfony/Component/DependencyInjection/Tests/Fixtures/php/services_default_env.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| <?php | ||
|
|
||
| use Symfony\Component\DependencyInjection\Argument\RewindableGenerator; | ||
| use Symfony\Component\DependencyInjection\ContainerInterface; | ||
| use Symfony\Component\DependencyInjection\Container; | ||
| use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException; | ||
| use Symfony\Component\DependencyInjection\Exception\LogicException; | ||
| use Symfony\Component\DependencyInjection\Exception\RuntimeException; | ||
| use Symfony\Component\DependencyInjection\ParameterBag\FrozenParameterBag; | ||
|
|
||
| /** | ||
| * This class has been auto-generated | ||
| * by the Symfony Dependency Injection Component. | ||
| * | ||
| * @final since Symfony 3.3 | ||
| */ | ||
| class Symfony_DI_PhpDumper_Test_DefaultParameters extends Container | ||
| { | ||
| private $parameters; | ||
| private $targetDirs = array(); | ||
|
|
||
| public function __construct() | ||
| { | ||
| $this->parameters = $this->getDefaultParameters(); | ||
|
|
||
| $this->services = $this->privates = array(); | ||
|
|
||
| $this->aliases = array(); | ||
| } | ||
|
|
||
| public function compile() | ||
| { | ||
| throw new LogicException('You cannot compile a dumped container that was already compiled.'); | ||
| } | ||
|
|
||
| public function isCompiled() | ||
| { | ||
| return true; | ||
| } | ||
|
|
||
| public function getRemovedIds() | ||
| { | ||
| return array( | ||
| 'Psr\\Container\\ContainerInterface' => true, | ||
| 'Symfony\\Component\\DependencyInjection\\ContainerInterface' => true, | ||
| ); | ||
| } | ||
|
|
||
| public function getParameter($name) | ||
| { | ||
| $name = (string) $name; | ||
|
|
||
| if (!(isset($this->parameters[$name]) || isset($this->loadedDynamicParameters[$name]) || array_key_exists($name, $this->parameters))) { | ||
| throw new InvalidArgumentException(sprintf('The parameter "%s" must be defined.', $name)); | ||
| } | ||
| if (isset($this->loadedDynamicParameters[$name])) { | ||
| return $this->loadedDynamicParameters[$name] ? $this->dynamicParameters[$name] : $this->getDynamicParameter($name); | ||
| } | ||
|
|
||
| return $this->parameters[$name]; | ||
| } | ||
|
|
||
| public function hasParameter($name) | ||
| { | ||
| $name = (string) $name; | ||
|
|
||
| return isset($this->parameters[$name]) || isset($this->loadedDynamicParameters[$name]) || array_key_exists($name, $this->parameters); | ||
| } | ||
|
|
||
| public function setParameter($name, $value) | ||
| { | ||
| throw new LogicException('Impossible to call set() on a frozen ParameterBag.'); | ||
| } | ||
|
|
||
| public function getParameterBag() | ||
| { | ||
| if (null === $this->parameterBag) { | ||
| $parameters = $this->parameters; | ||
| foreach ($this->loadedDynamicParameters as $name => $loaded) { | ||
| $parameters[$name] = $loaded ? $this->dynamicParameters[$name] : $this->getDynamicParameter($name); | ||
| } | ||
| $this->parameterBag = new FrozenParameterBag($parameters); | ||
| } | ||
|
|
||
| return $this->parameterBag; | ||
| } | ||
|
|
||
| private $loadedDynamicParameters = array( | ||
| 'fallback_env' => false, | ||
| 'hello' => false, | ||
| 'hello-bar' => false, | ||
| ); | ||
| private $dynamicParameters = array(); | ||
|
|
||
| /** | ||
| * Computes a dynamic parameter. | ||
| * | ||
| * @param string The name of the dynamic parameter to load | ||
| * | ||
| * @return mixed The value of the dynamic parameter | ||
| * | ||
| * @throws InvalidArgumentException When the dynamic parameter does not exist | ||
| */ | ||
| private function getDynamicParameter($name) | ||
| { | ||
| switch ($name) { | ||
| case 'fallback_env': $value = $this->getEnv('foobar'); break; | ||
| case 'hello': $value = $this->getEnv('default:fallback_param:bar'); break; | ||
| case 'hello-bar': $value = $this->getEnv('default:fallback_env:key:baz:json:foo'); break; | ||
| default: throw new InvalidArgumentException(sprintf('The dynamic parameter "%s" must be defined.', $name)); | ||
| } | ||
| $this->loadedDynamicParameters[$name] = true; | ||
|
|
||
| return $this->dynamicParameters[$name] = $value; | ||
| } | ||
|
|
||
| /** | ||
| * Gets the default parameters. | ||
| * | ||
| * @return array An array of the default parameters | ||
| */ | ||
| protected function getDefaultParameters() | ||
| { | ||
| return array( | ||
| 'fallback_param' => 'baz', | ||
| 'env(foobar)' => 'foobaz', | ||
| 'env(foo)' => '{"foo": "bar"}', | ||
| ); | ||
| } | ||
| } |