Function Hook_task_export_catalogue->run

Definitions

sources/hooks/systems/tasks/export_catalogue.php

  • Run the task hook.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Return: array

Parameters

Name Type Default Set Range Description
$catalogue_name ID_TEXT required parameter N/A N/A The catalogue to export
$file_type ?string Null N/A N/A The file type to export with (null: default)

Return

  • A tuple of at least 2: Return mime-type, content (either Tempcode, or a string, or a filename and file-path pair to a temporary file), map of HTTP headers if transferring immediately, map of ini_set commands if transferring immediately (null: show standard success message)
  • Type: ?array
  • Set: N/A
  • Range: N/A