Function __global->cns_render_forumview
Definitions
sources/cns_forumview.php
- Render the Conversr forumview.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $id | ?integer | No | No | required parameter | N/A | N/A | Forum ID (null: private topics) |
| $forum_info | ?array | No | No | required parameter | N/A | N/A | The forum row (null: private topics) |
| $current_filter_cat | string | No | No | required parameter | N/A | N/A | The filter category (blank if no filter) |
| $max | integer | No | No | required parameter | N/A | N/A | Maximum results to show |
| $start | integer | No | No | required parameter | N/A | N/A | Offset for result showing |
| $true_start | integer | No | No | required parameter | N/A | N/A | True offset when disconsidering keyset pagination |
| $sql_sup | string | No | No | required parameter | N/A | N/A | Extra SQL to append for where clause |
| $sql_sup_order_by | string | No | No | required parameter | N/A | N/A | Extra SQL to append as order clause |
| $sort | string | No | No | required parameter | N/A | N/A | Sort order |
| $keyset_clause | ?string | No | No | required parameter | N/A | N/A | Keyset clause (null: none) |
| $keyset_field | ?string | No | No | required parameter | N/A | N/A | Keyset field name so that we can extract values from DB result sets (null: none) |
| $root | AUTO_LINK | No | No | required parameter | N/A | N/A | Virtual root |
| $of_member_id | ?MEMBER | No | No | required parameter | N/A | N/A | The member to show private topics of (null: not showing private topics) |
| $breadcrumbs | Tempcode | No | No | required parameter | N/A | N/A | The breadcrumbs |
Returns
- Either Tempcode (an interface that must be shown) or a pair: The main Tempcode, the forum name (string). For a PT view, it is always a tuple, never raw Tempcode (as it can go inside a tabset).
- Type: mixed
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Render the Conversr forumview.
*
* @param ?integer $id Forum ID (null: private topics)
* @param ?array $forum_info The forum row (null: private topics)
* @param string $current_filter_cat The filter category (blank if no filter)
* @param integer $max Maximum results to show
* @param integer $start Offset for result showing
* @param integer $true_start True offset when disconsidering keyset pagination
* @param string $sql_sup Extra SQL to append for where clause
* @param string $sql_sup_order_by Extra SQL to append as order clause
* @param string $sort Sort order
* @param ?string $keyset_clause Keyset clause (null: none)
* @param ?string $keyset_field Keyset field name so that we can extract values from DB result sets (null: none)
* @param AUTO_LINK $root Virtual root
* @param ?MEMBER $of_member_id The member to show private topics of (null: not showing private topics)
* @param Tempcode $breadcrumbs The breadcrumbs
* @return mixed Either Tempcode (an interface that must be shown) or a pair: The main Tempcode, the forum name (string). For a PT view, it is always a tuple, never raw Tempcode (as it can go inside a tabset).
*/
function cns_render_forumview(?int $id, ?array $forum_info, string $current_filter_cat, int $max, int $start, int $true_start, string $sql_sup, string $sql_sup_order_by, string $sort, ?string $keyset_clause, ?string $keyset_field, int $root, ?int $of_member_id, object $breadcrumbs)
* Render the Conversr forumview.
*
* @param ?integer $id Forum ID (null: private topics)
* @param ?array $forum_info The forum row (null: private topics)
* @param string $current_filter_cat The filter category (blank if no filter)
* @param integer $max Maximum results to show
* @param integer $start Offset for result showing
* @param integer $true_start True offset when disconsidering keyset pagination
* @param string $sql_sup Extra SQL to append for where clause
* @param string $sql_sup_order_by Extra SQL to append as order clause
* @param string $sort Sort order
* @param ?string $keyset_clause Keyset clause (null: none)
* @param ?string $keyset_field Keyset field name so that we can extract values from DB result sets (null: none)
* @param AUTO_LINK $root Virtual root
* @param ?MEMBER $of_member_id The member to show private topics of (null: not showing private topics)
* @param Tempcode $breadcrumbs The breadcrumbs
* @return mixed Either Tempcode (an interface that must be shown) or a pair: The main Tempcode, the forum name (string). For a PT view, it is always a tuple, never raw Tempcode (as it can go inside a tabset).
*/
function cns_render_forumview(?int $id, ?array $forum_info, string $current_filter_cat, int $max, int $start, int $true_start, string $sql_sup, string $sql_sup_order_by, string $sort, ?string $keyset_clause, ?string $keyset_field, int $root, ?int $of_member_id, object $breadcrumbs)
