Function __global->create_selection_list_catalogues

Definitions

sources/catalogues.php

  • Get a nice, formatted, HTML list of all the catalogues.
  • 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 ?ID_TEXT No No Null N/A N/A The name of the currently selected catalogue (null: none selected)
$prefer_ones_with_entries boolean No No False N/A N/A If there are too many to list prefer to get ones with entries rather than just the newest
$only_submittable boolean No No False N/A N/A Whether to only show catalogues that can be submitted to
$updated_since ?TIME No No Null N/A N/A Time from which content must be updated (null: no limit)

Returns

  • Catalogue selection list
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get a nice, formatted, HTML list of all the catalogues.
 *
 * @param  ?ID_TEXT $it The name of the currently selected catalogue (null: none selected)
 * @param  boolean $prefer_ones_with_entries If there are too many to list prefer to get ones with entries rather than just the newest
 * @param  boolean $only_submittable Whether to only show catalogues that can be submitted to
 * @param  ?TIME $updated_since Time from which content must be updated (null: no limit)
 * @return Tempcode Catalogue selection list
 */
function create_selection_list_catalogues(?string $it = null, bool $prefer_ones_with_entries = false, bool $only_submittable = false, ?int $updated_since = null) : object