function ds_prepare_regions_variable_documentation in Display Suite 7.2

Same name and namespace in other branches

1. 8.2 drush/ds.drush.inc \ds_prepare_regions_variable_documentation()
2. 8.3 drush/ds.drush.inc \ds_prepare_regions_variable_documentation()
3. 7 ds.drush.inc \ds_prepare_regions_variable_documentation()

Prepare variable documentation for an array of regions.

1 call to ds_prepare_regions_variable_documentation()

drush_ds_build in drush/ds.drush.inc

Create a basic template and configuration file for a new Display Suite layout.

File

drush/ds.drush.inc, line 170

Display Suite drush integration.

Code

function ds_prepare_regions_variable_documentation($region_names) {
  $output = array();
  foreach ($region_names as $name) {
    $machine_name = ds_prepare_machine_name($name);
    $output[] = <<<END
 *
 * - \${<span class="php-variable">$machine_name</span>}: Rendered content for the "{<span class="php-variable">$name</span>}" region.
 * - \${<span class="php-variable">$machine_name</span>}_classes: String of classes that can be used to style the "{<span class="php-variable">$name</span>}" region.
END;
  }
  return implode("\n", $output);
}