Function __global->_create_selection_list

Definitions

sources/sitemap.php

  • Recurse function for create_selection_list.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
&$out Tempcode Yes No required parameter N/A N/A Output Tempcode
$node array No No required parameter N/A N/A Node being recursed
$default ?ID_TEXT No No required parameter N/A N/A Default selection (null: none)
$valid_selectable_content_types ?array No No required parameter N/A N/A List of node types we will allow to be selectable (null: no limit)
$check_permissions_against integer No No required parameter N/A N/A Check permissions according to this bitmask of possibilities (requiring all in the bitmask to be matched)
$check_permissions_for ?MEMBER No No required parameter N/A N/A The member we are checking permissions for (null: current member)
$only_owned ?MEMBER No No required parameter N/A N/A The member we are only finding owned content of (null: no such limit); nodes leading up to owned content will be shown, but not as selectable
$use_compound_list boolean No No required parameter N/A N/A Whether to produce selection IDs as a comma-separated list of all selectable sub-nodes
$filter_func ?mixed No No required parameter N/A N/A Filter function for limiting what rows will be included (null: none)
$depth integer No No 0 N/A N/A Recursion depth

Returns

  • Compound list
  • Type: string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Recurse function for create_selection_list.
 *
 * @param  Tempcode $out Output Tempcode
 * @param  array $node Node being recursed
 * @param  ?ID_TEXT $default Default selection (null: none)
 * @param  ?array $valid_selectable_content_types List of node types we will allow to be selectable (null: no limit)
 * @param  integer $check_permissions_against Check permissions according to this bitmask of possibilities (requiring all in the bitmask to be matched)
 * @param  ?MEMBER $check_permissions_for The member we are checking permissions for (null: current member)
 * @param  ?MEMBER $only_owned The member we are only finding owned content of (null: no such limit); nodes leading up to owned content will be shown, but not as selectable
 * @param  boolean $use_compound_list Whether to produce selection IDs as a comma-separated list of all selectable sub-nodes
 * @param  ?mixed $filter_func Filter function for limiting what rows will be included (null: none)
 * @param  integer $depth Recursion depth
 * @return string Compound list
 */
function _create_selection_list(object &$out, array $node, ?string $default, ?array $valid_selectable_content_types, int $check_permissions_against, ?int $check_permissions_for, ?int $only_owned, bool $use_compound_list, $filter_func, int $depth = 0) : string