Function Hook_task_import_filesystem_downloads->run

Definitions

sources/hooks/systems/tasks/import_filesystem_downloads.php

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

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$destination AUTO_LINK No No required parameter N/A N/A The category to import to
$server_path PATH No No required parameter N/A N/A The import path
$subfolders boolean No No required parameter N/A N/A Whether to import subfolders

Returns

  • 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

Preview

Code (PHP)

/**
 * Run the task hook.
 *
 * @param  AUTO_LINK $destination The category to import to
 * @param  PATH $server_path The import path
 * @param  boolean $subfolders Whether to import subfolders
 * @return ?array 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)
 */
public function run(int $destination, string $server_path, bool $subfolders) : ?array