Function __global->cns_get_private_topics
Definitions
sources/cns_forumview_pt.php
- Get a map of details relating to the Private Topics of a certain member.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $start | integer | No | No | 0 | N/A | N/A | The start row for getting details of topics in the Private Topic forum (i.e. 0 is newest, higher is starting further back in time). |
| $true_start | integer | No | No | 0 | N/A | N/A | True offset when disconsidering keyset pagination |
| $max | ?integer | No | No | Null | N/A | N/A | The maximum number of topics to get detail of (null: default) |
| $sql_sup | string | No | No | Blank (empty string) | N/A | N/A | Extra SQL to append |
| $sql_sup_order_by | string | No | No | Blank (empty string) | N/A | N/A | Extra SQL to append as order clause |
| $member_id | ?MEMBER | No | No | Null | N/A | N/A | The member to get Private Topics of (null: current member) |
Returns
- The details
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get a map of details relating to the Private Topics of a certain member.
*
* @param integer $start The start row for getting details of topics in the Private Topic forum (i.e. 0 is newest, higher is starting further back in time).
* @param integer $true_start True offset when disconsidering keyset pagination
* @param ?integer $max The maximum number of topics to get detail of (null: default)
* @param string $sql_sup Extra SQL to append
* @param string $sql_sup_order_by Extra SQL to append as order clause
* @param ?MEMBER $member_id The member to get Private Topics of (null: current member)
* @return array The details
*/
function cns_get_private_topics(int $start = 0, int $true_start = 0, ?int $max = null, string $sql_sup = '', string $sql_sup_order_by = '', ?int $member_id = null) : array
* Get a map of details relating to the Private Topics of a certain member.
*
* @param integer $start The start row for getting details of topics in the Private Topic forum (i.e. 0 is newest, higher is starting further back in time).
* @param integer $true_start True offset when disconsidering keyset pagination
* @param ?integer $max The maximum number of topics to get detail of (null: default)
* @param string $sql_sup Extra SQL to append
* @param string $sql_sup_order_by Extra SQL to append as order clause
* @param ?MEMBER $member_id The member to get Private Topics of (null: current member)
* @return array The details
*/
function cns_get_private_topics(int $start = 0, int $true_start = 0, ?int $max = null, string $sql_sup = '', string $sql_sup_order_by = '', ?int $member_id = null) : array
