Function __global->cns_get_topic_array

Definitions

sources/cns_forumview.php

  • Get details of a topic (to show eventually as a row in a forum or results view). This is a helper function, and thus the interface is not very user friendly.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: array

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$topic_row array No No required parameter N/A N/A The DB row of the topic
$member_id MEMBER No No required parameter N/A N/A The member the details are being prepared for
$hot_topic_definition integer No No required parameter N/A N/A The hot topic definition (taken from the config options)
$involved boolean No No required parameter N/A N/A Whether the viewing member has a post in the topic

Returns

  • The details
  • Type: array
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get details of a topic (to show eventually as a row in a forum or results view). This is a helper function, and thus the interface is not very user friendly.
 *
 * @param  array $topic_row The DB row of the topic
 * @param  MEMBER $member_id The member the details are being prepared for
 * @param  integer $hot_topic_definition The hot topic definition (taken from the config options)
 * @param  boolean $involved Whether the viewing member has a post in the topic
 * @return array The details
 */
function cns_get_topic_array(array $topic_row, int $member_id, int $hot_topic_definition, bool $involved) : array