annotate vendor/symfony/dependency-injection/EnvVarProcessorInterface.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 1fec387a4317
children
rev   line source
Chris@14 1 <?php
Chris@14 2
Chris@14 3 /*
Chris@14 4 * This file is part of the Symfony package.
Chris@14 5 *
Chris@14 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@14 7 *
Chris@14 8 * For the full copyright and license information, please view the LICENSE
Chris@14 9 * file that was distributed with this source code.
Chris@14 10 */
Chris@14 11
Chris@14 12 namespace Symfony\Component\DependencyInjection;
Chris@14 13
Chris@14 14 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
Chris@14 15
Chris@14 16 /**
Chris@14 17 * The EnvVarProcessorInterface is implemented by objects that manage environment-like variables.
Chris@14 18 *
Chris@14 19 * @author Nicolas Grekas <p@tchwork.com>
Chris@14 20 */
Chris@14 21 interface EnvVarProcessorInterface
Chris@14 22 {
Chris@14 23 /**
Chris@14 24 * Returns the value of the given variable as managed by the current instance.
Chris@14 25 *
Chris@14 26 * @param string $prefix The namespace of the variable
Chris@14 27 * @param string $name The name of the variable within the namespace
Chris@14 28 * @param \Closure $getEnv A closure that allows fetching more env vars
Chris@14 29 *
Chris@14 30 * @return mixed
Chris@14 31 *
Chris@14 32 * @throws RuntimeException on error
Chris@14 33 */
Chris@14 34 public function getEnv($prefix, $name, \Closure $getEnv);
Chris@14 35
Chris@14 36 /**
Chris@14 37 * @return string[] The PHP-types managed by getEnv(), keyed by prefixes
Chris@14 38 */
Chris@14 39 public static function getProvidedTypes();
Chris@14 40 }