Function Hook_task_import_filesystem_downloads->filesystem_recursive_downloads_scan

Definitions

sources/hooks/systems/tasks/import_filesystem_downloads.php

  • Worker function to do a filesystem import.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: int

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$server_path PATH No No required parameter N/A N/A Filesystem-based path from where we are reading files
$server_url URLPATH No No required parameter N/A N/A URL-based path from where we are reading files
$dest_cat AUTO_LINK No No required parameter N/A N/A The destination downloading category
$make_subfolders boolean No No required parameter N/A N/A Whether we add hierarchically (as opposed to a flat category fill)

Returns

  • Number of downloads added
  • Type: integer
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Worker function to do a filesystem import.
 *
 * @param  PATH $server_path Filesystem-based path from where we are reading files
 * @param  URLPATH $server_url URL-based path from where we are reading files
 * @param  AUTO_LINK $dest_cat The destination downloading category
 * @param  boolean $make_subfolders Whether we add hierarchically (as opposed to a flat category fill)
 * @return integer Number of downloads added
 */
protected function filesystem_recursive_downloads_scan(string $server_path, string $server_url, int $dest_cat, bool $make_subfolders) : int