function InputConfigurator::describeAll

Returns the description for all inputs of this recipe and its dependencies.

Return value

string[] The descriptions of every input defined by the recipe and its dependencies, keyed by the input's fully qualified name (i.e., prefixed by the name of the recipe that defines it).

File

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

Class

InputConfigurator
Collects and validates input values for a recipe.

Namespace

Drupal\Core\Recipe

Code

public function describeAll() : array {
    $descriptions = [];
    foreach ($this->dependencies->recipes as $dependency) {
        $descriptions = array_merge($descriptions, $dependency->input
            ->describeAll());
    }
    foreach ($this->data as $data) {
        $name = $data->getName();
        $descriptions[$name] = $data->getDataDefinition()
            ->getDescription();
    }
    return $descriptions;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.