Returns the default value for an input definition.

Parameters

array $definition: An input definition. Must contain a `source` element, which can be one of `config`, `env`, or `value`:

• If `source` is `config`, there must also be a `config` element, which is a two-element indexed array containing (in order) the name of an extant config object, and a property path within that object.
• If `source` is `env`, there must also be an `env` element, which is the name of an environment variable to return. The value will always be returned as a string. If the environment variable is not set, an empty string will be returned.
• If `source` is 'value', then there must be a `value` element, which will be returned as-is.

Return value

mixed The default value.

1 call to InputConfigurator::getDefaultValue()

InputConfigurator::collectAll in core/lib/Drupal/Core/Recipe/InputConfigurator.php

Collects input values for this recipe and its dependencies.

File

core/lib/Drupal/Core/Recipe/InputConfigurator.php, line 189

Class

InputConfigurator

Collects and validates input values for a recipe.

Namespace

Drupal\Core\Recipe

Code

private function getDefaultValue(DataDefinition $definition) : mixed {
  $settings = $definition->getSetting('default');
  if ($settings['source'] === 'config') {
    [
      $name,
      $key,
    ] = $settings['config'];
    $config = \Drupal::config($name);
    if ($config->isNew()) {
      throw new \RuntimeException("The '{$name}' config object does not exist.");
    }
    return $config->get($key);
  }
  elseif ($settings['source'] === 'env') {
    // getenv() accepts NULL to return an array of all environment variables,
    // but this makes no sense in a recipe. There is no valid situation where
    // the name of the environment variable should be empty.
    if (empty($settings['env'])) {
      throw new \RuntimeException("The name of the environment variable cannot be empty.");
    }
    // If the variable doesn't exist, getenv() returns FALSE; we can represent
    // that as an empty string.
    return (string) getenv($settings['env']);
  }
  return $settings['value'];
}

---