Function __global->create_selection_list_downloads_tree

Definitions

sources/downloads.php

  • Get a nice, formatted HTML list of downloads, in download tree structure.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$it ?AUTO_LINK No No Null N/A N/A The currently selected entry (null: none selected)
$submitter ?AUTO_LINK No No Null N/A N/A Only show entries submitted by this member (null: no filter)
$shun ?AUTO_LINK No No Null N/A N/A Download we do not want to show (null: none to not show)
$use_compound_list boolean No No False N/A N/A Whether to get a list of child categories (not just direct ones, recursively), instead of just IDs
$editable_filter boolean No No False N/A N/A Whether to only show for what may be edited by the current member

Returns

  • The list of entries
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get a nice, formatted HTML list of downloads, in download tree structure.
 *
 * @param  ?AUTO_LINK $it The currently selected entry (null: none selected)
 * @param  ?AUTO_LINK $submitter Only show entries submitted by this member (null: no filter)
 * @param  ?AUTO_LINK $shun Download we do not want to show (null: none to not show)
 * @param  boolean $use_compound_list Whether to get a list of child categories (not just direct ones, recursively), instead of just IDs
 * @param  boolean $editable_filter Whether to only show for what may be edited by the current member
 * @return Tempcode The list of entries
 */

function create_selection_list_downloads_tree(?int $it = null, ?int $submitter = null, ?int $shun = null, bool $use_compound_list = false, bool $editable_filter = false) : object