Difference between revisions of "Nats display stats retention"
From TMM Wiki
Jump to navigationJump to searchm |
TMMStephenY (talk | contribs) m |
||
| Line 73: | Line 73: | ||
== Notes == | == Notes == | ||
None. | None. | ||
| + | |||
| + | [[Category:NATS4 Template Functions]] | ||
Latest revision as of 16:35, 20 May 2011
nats_display_stats_retention
Display retention statistics.
Alias: display_stats_retention
Parameters
(Required parameters in bold)
| Parameter | Description | Possible Values | Default Value | Example |
|---|---|---|---|---|
| tpl | Template used to display output | Any valid template | The template, function_display_stats_retention | tpl="my_template" |
| period | The period to get statistics for | Any valid period I.D. number | 0 | period="7" |
| no_form_vars | Don't use any form variables | 1 | None. | no_form_vars="1" |
| count | Maximum number of results to display (Click link for details) | Zero or any whole number greater than zero | 10 | count=20 |
| start | Hide all results lower than this number (Click link for details) | Any whole number greater than zero | None. (Doesn't hide any results) | start=10 |
| order | Display statistics in this order | 1 | None. | order="1" |
| no_order | Prevent NATS from displaying statistics in order (overrides above parameter) | 1 | None. | no_order="1" |
| assign_prefix | Prefix output variables with this word. (Click link for details) | Any valid Smarty variable name | None. (No prefix is used) | assign_prefix="myvar" |
Output
Displays member retention statistics using the function_display_stats_retention template. Also store statistics in the following Smarty variables and arrays: {$referral_count}, {$stats}, and {$totals}.
Notes
None.
