function outputformat_drush_engine_type_info

8.0.x outputformat.drush.inc outputformat_drush_engine_type_info()
6.x outputformat.drush.inc outputformat_drush_engine_type_info()
7.x outputformat.drush.inc outputformat_drush_engine_type_info()
master outputformat.drush.inc outputformat_drush_engine_type_info()

Implementation of hook_drush_engine_type_info().

File

commands/core/outputformat.drush.inc, line 40
Core drush output formats.

Code

function outputformat_drush_engine_type_info() {
  $info = array();
  $info['outputformat'] = array(
    'description' => 'Output formatting options selection and use.',
    'topic' => 'docs-output-formats',
    'topic-file' => 'docs/output-formats.html',
    'combine-help' => TRUE,
    'option' => 'format',
    'options' => array(
      'format' => array(
        'description' => 'Select output format.',
        'example-value' => 'json',
      ),
      'fields' => array(
        'description' => 'Fields to output.',
        'example-value' => 'field1,field2',
        'value' => 'required',
        'list' => TRUE,
      ),
      'list-separator' => array(
        'description' => 'Specify how elements in a list should be separated. In lists of lists, this applies to the elements in the inner lists.',
        'hidden' => TRUE,
      ),
      'line-separator' => array(
        'description' => 'In nested lists of lists, specify how the outer lists ("lines") should be separated.',
        'hidden' => TRUE,
      ),
      'field-labels' => array(
        'description' => 'Add field labels before first line of data. Default is on; --field-labels=0 to disable.',
        'default' => '1',
        'key' => 'include-field-labels',
      ),
    ),
    
    // Allow output formats to declare their
    // "output data type" instead of their
    // "required engine capability" for readability.
    'config-aliases' => array(
      'output-data-type' => 'require-engine-capability',
    ),
  );
  return $info;
}