Function __global->_notifications_build_category_tree

Definitions

sources/notifications2.php

  • Build a tree UI for all categories available.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$_notification_types array No No required parameter N/A N/A Notification types
$notification_code ID_TEXT No No required parameter N/A N/A The notification code to work with
$ob object No No required parameter N/A N/A Notification hook object
$id ?ID_TEXT No No required parameter N/A N/A Category we're looking under (null: root)
$depth integer No No required parameter N/A N/A Recursion depth
$force_change_children_to ?boolean No No required parameter N/A N/A Value to change setting to (null: do not change)
&$done_get_change boolean Yes No required parameter N/A N/A Whether we have made a change to the settings

Returns

  • UI
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Build a tree UI for all categories available.
 *
 * @param  array $_notification_types Notification types
 * @param  ID_TEXT $notification_code The notification code to work with
 * @param  object $ob Notification hook object
 * @param  ?ID_TEXT $id Category we're looking under (null: root)
 * @param  integer $depth Recursion depth
 * @param  ?boolean $force_change_children_to Value to change setting to (null: do not change)
 * @param  boolean $done_get_change Whether we have made a change to the settings
 * @return Tempcode UI
 */
function _notifications_build_category_tree(array $_notification_types, string $notification_code, object $ob, ?string $id, int $depth, ?bool $force_change_children_to, bool &$done_get_change) : object