Difference between revisions of "Nats list tours"
From TMM Wiki
Jump to navigationJump to searchm |
(No difference)
|
Revision as of 14:27, 3 November 2008
Applies to NATS 4.0.25 and greater.
nats_list_tours
Creates a the list of all tours offered by a particular program.
Alias: list_tours
Parameters
(Required parameters in bold)
| Parameter | Description | Possible Values | Default Value | Example |
|---|---|---|---|---|
| program | The program's ID number | Any valid program ID number | The default program ID number | program="123" |
| site | The site's ID number | Any valid site ID number | The default site ID number | site="123" |
| shortname | If set to "1", adds the tour's shortname to its name in the output | 0 or 1 (exclusive). | Off; does not print shortname | shortname="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
Output placed in Smarty array $tours. Each element in the array is a tour. For example:
Array (2) 1 => Array (1) 1 => "Default Tour" 2 => Array (1) 2 => "Default Tour"
If the shortname parameter is set, the each tour name starts with its shortname. For example:
1 => Array (1) 1 => "(MAIN) Default Tour" 2 => Array (1) 2 => "(MAIN) Default Tour"
Notes
None.
