Function __global->_helper_get_forum_topic_posts
Definitions
sources/cns_forum_driver_helper.php
- Get an array of maps for the topic in the given forum.
- Is abstract?: No
- Is static?: No
- Is final?: No
- Return: N/A
Parameters
| Name | Type | Default | Set | Range | Description |
|---|---|---|---|---|---|
| $this_ref | object | required parameter | N/A | N/A | Link to the real forum driver |
| $topic_id | ?integer | required parameter | N/A | N/A | The topic ID (null: does not exist) |
| $count | ?integer | required parameter | N/A | N/A | The comment count will be returned here by reference (null: no return) |
| $max | ?integer | required parameter | N/A | N/A | Maximum comments to returned (null: no limit) |
| $start | integer | required parameter | N/A | N/A | Comment to start at |
| $mark_read | boolean | True | N/A | N/A | Whether to mark the topic read |
| $reverse | boolean | False | N/A | N/A | Whether to show in reverse |
| $light_if_threaded | boolean | False | N/A | N/A | Whether to only load minimal details if it is a threaded topic |
| $post_ids | ?array | Null | N/A | N/A | List of post IDs to load (null: no filter) |
| $load_spacer_posts_too | boolean | False | N/A | N/A | Whether to load spacer posts |
| $sort | ID_TEXT | date | N/A | N/A | Preferred sort order (appropriate will use rating if threaded, other |
Return
- The array of maps (Each map is: title, message, member, date) (-1 for no such forum, -2 for no such topic)
- Type: mixed
- Set: N/A
- Range: N/A