function taxonomy_csv_export in Taxonomy CSV import/export 7.4

Same name and namespace in other branches

1. 6.5 export/taxonomy_csv.export.api.inc \taxonomy_csv_export()
2. 6.2 export/taxonomy_csv.export.api.inc \taxonomy_csv_export()
3. 6.3 export/taxonomy_csv.export.api.inc \taxonomy_csv_export()
4. 6.4 export/taxonomy_csv.export.api.inc \taxonomy_csv_export()
5. 7.5 export/taxonomy_csv.export.api.inc \taxonomy_csv_export()

Process the export of a vocabulary.

If not used in a form, don't forget to use batch_process().

Parameters

$options: An associative array of options:

• export_format : see _taxonomy_csv_values('list_export_format')
• vocabulary_id : vocabulary id to export (default: 0, which means all)
• delimiter : one character csv delimiter (default: ',')
• enclosure : zero or one character csv enclosure (default: '"')
• line_ending : 'Unix' (default), 'Mac' or 'MS-DOS'
• order : order of terms: 'name' (default), 'tid' or 'weight'

// Specific to def_links:

• def_links_terms_ids : 'name_if_needed' (default), 'name' or 'tid'
• def_links_vocabularies_ids : 'none' (default), 'name' or 'vid'

// Level of result process infos.

• check_options : boolean. check or not (default) this array of options
• result_display: boolean. display or not (default). Only used with UI.
• result_duplicates: boolean. display or not (default) duplicate terms.

Only export_format is needed. Other options have default values. Warning: default values are different with UI.

Return value

Array of errors or file object to download (need to execute batch process; result is logged in watchdog).

File

export/taxonomy_csv.export.api.inc, line 45

Validate export options and manage export process.

Code

function taxonomy_csv_export($options) {

  // Complete $options with default values if needed.
  // Default api and UI options are different.
  $options += _taxonomy_csv_values('list_export_default_values_api');

  // Presave a file in order to check access to temporary folder.
  $messages = _taxonomy_csv_export_output_presave($options);
  if (count($messages)) {
    return $messages;
  }

  // Process export.
  taxonomy_csv_vocabulary_export($options);

  // File object.
  return $options['file'];
}