Function CMS_Topic->_render_post_tree

Definitions

sources/topics.php

  • Render posts.
  • Visibility: protected
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$num_to_show_limit integer No No required parameter N/A N/A Maximum to load
$tree array No No required parameter N/A N/A Tree structure of posts
$may_reply boolean No No required parameter N/A N/A Whether the current user may reply to the topic (influences what buttons show)
$highlight_by_member ?AUTO_LINK No No required parameter N/A N/A Only show posts under here (null: show posts from root)
$all_individual_review_ratings array No No required parameter N/A N/A Review ratings rows
$forum_id AUTO_LINK No No required parameter N/A N/A ID of forum this topic in in
$topic_info ?array No No required parameter N/A N/A The topic row (null: not running Conversr)
$depth integer No No 0 N/A N/A The recursion depth

Returns

  • Rendered tree structure
  • Type: Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Render posts.
 *
 * @param  integer $num_to_show_limit Maximum to load
 * @param  array $tree Tree structure of posts
 * @param  boolean $may_reply Whether the current user may reply to the topic (influences what buttons show)
 * @param  ?AUTO_LINK $highlight_by_member Only show posts under here (null: show posts from root)
 * @param  array $all_individual_review_ratings Review ratings rows
 * @param  AUTO_LINK $forum_id ID of forum this topic in in
 * @param  ?array $topic_info The topic row (null: not running Conversr)
 * @param  integer $depth The recursion depth
 * @return Tempcode Rendered tree structure
 */
protected function _render_post_tree(int $num_to_show_limit, array $tree, bool $may_reply, ?int $highlight_by_member, array $all_individual_review_ratings, int $forum_id, ?array $topic_info, int $depth = 0) : object