nats_dump_data

Gets a statistics dump.

Alias: dump_data

Parameters

(Required parameters in bold)

Parameter
Description
Possible Values
Default Value
Example

Template used to display output

Any valid template

The template, function_dump_data_xml

tpl="my_template"

no_form_vars

Don't use any variables from the form

1

None. (Uses form variables)

no_form_vars="1"

dump_array

Array to store the dump

Any valid Smarty array containing only lowercase letters, numbers, underscores, or spaces

stats

dump_array="my_array"

function

The function used to get the dump

Any valid NATS function name containing only lowercase letters, numbers, underscores, or spaces

display_stats

function="display_stats_referrals"

Set variables but don't display the template

1

None. The template is displayed.

data_only=1

Output

Displays the statistics using the function_dump_data_xml template. Also stores data in the {$stats} array or whatever array you specified with the dump_array parameter.

Last updated

Was this helpful?