vendor/symfony/dependency-injection/ParameterBag/EnvPlaceholderParameterBag.php line 58

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\DependencyInjection\ParameterBag;
  14. use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
  15. use Symfony\Component\DependencyInjection\Exception\RuntimeException;
  17. /**
  18.  * @author Nicolas Grekas <p@tchwork.com>
  19.  */
  20. class EnvPlaceholderParameterBag extends ParameterBag
  21. {
  22.     private $envPlaceholderUniquePrefix;
  23.     private $envPlaceholders = [];
  24.     private $unusedEnvPlaceholders = [];
  25.     private $providedTypes = [];
  27.     private static $counter = 0;
  29.     /**
  30.      * {@inheritdoc}
  31.      */
  32.     public function get($name)
  33.     {
  34.         if (str_starts_with($name, 'env(') && str_ends_with($name, ')') && 'env()' !== $name) {
  35.             $env = substr($name, 4, -1);
  37.             if (isset($this->envPlaceholders[$env])) {
  38.                 foreach ($this->envPlaceholders[$env] as $placeholder) {
  39.                     return $placeholder; // return first result
  40.                 }
  41.             }
  42.             if (isset($this->unusedEnvPlaceholders[$env])) {
  43.                 foreach ($this->unusedEnvPlaceholders[$env] as $placeholder) {
  44.                     return $placeholder; // return first result
  45.                 }
  46.             }
  47.             if (!preg_match('/^(?:\w*+:)*+\w++$/', $env)) {
  48.                 throw new InvalidArgumentException(sprintf('Invalid "%s" name: only "word" characters are allowed.', $name));
  49.             }
  51.             if ($this->has($name)) {
  52.                 $defaultValue = parent::get($name);
  54.                 if (null !== $defaultValue && !is_scalar($defaultValue)) { // !is_string in 5.0
  55.                     //throw new RuntimeException(sprintf('The default value of an env() parameter must be a string or null, but "%s" given to "%s".', \gettype($defaultValue), $name));
  56.                     throw new RuntimeException(sprintf('The default value of an env() parameter must be scalar or null, but "%s" given to "%s".', \gettype($defaultValue), $name));
  57.                 } elseif (is_scalar($defaultValue) && !\is_string($defaultValue)) {
  58.                     @trigger_error(sprintf('A non-string default value of an env() parameter is deprecated since 4.3, cast "%s" to string instead.', $name), \E_USER_DEPRECATED);
  59.                 }
  60.             }
  62.             $uniqueName = md5($name.'_'.self::$counter++);
  63.             $placeholder = sprintf('%s_%s_%s', $this->getEnvPlaceholderUniquePrefix(), str_replace(':', '_', $env), $uniqueName);
  64.             $this->envPlaceholders[$env][$placeholder] = $placeholder;
  66.             return $placeholder;
  67.         }
  69.         return parent::get($name);
  70.     }
  72.     /**
  73.      * Gets the common env placeholder prefix for env vars created by this bag.
  74.      */
  75.     public function getEnvPlaceholderUniquePrefix(): string
  76.     {
  77.         if (null === $this->envPlaceholderUniquePrefix) {
  78.             $reproducibleEntropy = unserialize(serialize($this->parameters));
  79.             array_walk_recursive($reproducibleEntropy, function (&$v) { $v = null; });
  80.             $this->envPlaceholderUniquePrefix = 'env_'.substr(md5(serialize($reproducibleEntropy)), -16);
  81.         }
  83.         return $this->envPlaceholderUniquePrefix;
  84.     }
  86.     /**
  87.      * Returns the map of env vars used in the resolved parameter values to their placeholders.
  88.      *
  89.      * @return string[][] A map of env var names to their placeholders
  90.      */
  91.     public function getEnvPlaceholders()
  92.     {
  93.         return $this->envPlaceholders;
  94.     }
  96.     public function getUnusedEnvPlaceholders(): array
  97.     {
  98.         return $this->unusedEnvPlaceholders;
  99.     }
  101.     public function clearUnusedEnvPlaceholders()
  102.     {
  103.         $this->unusedEnvPlaceholders = [];
  104.     }
  106.     /**
  107.      * Merges the env placeholders of another EnvPlaceholderParameterBag.
  108.      */
  109.     public function mergeEnvPlaceholders(self $bag)
  110.     {
  111.         if ($newPlaceholders = $bag->getEnvPlaceholders()) {
  112.             $this->envPlaceholders += $newPlaceholders;
  114.             foreach ($newPlaceholders as $env => $placeholders) {
  115.                 $this->envPlaceholders[$env] += $placeholders;
  116.             }
  117.         }
  119.         if ($newUnusedPlaceholders = $bag->getUnusedEnvPlaceholders()) {
  120.             $this->unusedEnvPlaceholders += $newUnusedPlaceholders;
  122.             foreach ($newUnusedPlaceholders as $env => $placeholders) {
  123.                 $this->unusedEnvPlaceholders[$env] += $placeholders;
  124.             }
  125.         }
  126.     }
  128.     /**
  129.      * Maps env prefixes to their corresponding PHP types.
  130.      */
  131.     public function setProvidedTypes(array $providedTypes)
  132.     {
  133.         $this->providedTypes = $providedTypes;
  134.     }
  136.     /**
  137.      * Gets the PHP types corresponding to env() parameter prefixes.
  138.      *
  139.      * @return string[][]
  140.      */
  141.     public function getProvidedTypes()
  142.     {
  143.         return $this->providedTypes;
  144.     }
  146.     /**
  147.      * {@inheritdoc}
  148.      */
  149.     public function resolve()
  150.     {
  151.         if ($this->resolved) {
  152.             return;
  153.         }
  154.         parent::resolve();
  156.         foreach ($this->envPlaceholders as $env => $placeholders) {
  157.             if (!$this->has($name = "env($env)")) {
  158.                 continue;
  159.             }
  160.             if (is_numeric($default = $this->parameters[$name])) {
  161.                 if (!\is_string($default)) {
  162.                     @trigger_error(sprintf('A non-string default value of env parameter "%s" is deprecated since 4.3, cast it to string instead.', $env), \E_USER_DEPRECATED);
  163.                 }
  164.                 $this->parameters[$name] = (string) $default;
  165.             } elseif (null !== $default && !is_scalar($default)) { // !is_string in 5.0
  166.                 //throw new RuntimeException(sprintf('The default value of env parameter "%s" must be a string or null, "%s" given.', $env, \gettype($default)));
  167.                 throw new RuntimeException(sprintf('The default value of env parameter "%s" must be scalar or null, "%s" given.', $env, \gettype($default)));
  168.             } elseif (is_scalar($default) && !\is_string($default)) {
  169.                 @trigger_error(sprintf('A non-string default value of env parameter "%s" is deprecated since 4.3, cast it to string instead.', $env), \E_USER_DEPRECATED);
  170.             }
  171.         }
  172.     }
  173. }