Difference between revisions of "Nats list tours"
From TMM Wiki
Jump to navigationJump to search| (4 intermediate revisions by 2 users not shown) | |||
| Line 5: | Line 5: | ||
= nats_list_tours = | = nats_list_tours = | ||
| − | Creates | + | Creates the list of all [[Common Terms#Tours|tours]] offered by a particular [[Common Terms#Program|program]]. |
Alias: [[list_tours]] | Alias: [[list_tours]] | ||
| Line 61: | Line 61: | ||
</pre> | </pre> | ||
| − | If the ''shortname'' parameter is set, | + | If the ''shortname'' parameter is set, then each tour name starts with its shortname. For example: |
<pre> | <pre> | ||
| Line 227: | Line 227: | ||
https_use => "0" | https_use => "0" | ||
</pre> | </pre> | ||
| + | |||
| + | == Site Groups == | ||
| + | There are three(3) arrays contained in the output that return site group information: | ||
| + | |||
| + | *{$site_groups} - Contains an array for each site group. Each group-specific array then contains: | ||
| + | **site_group_id - The ID# of the group. | ||
| + | **name - The full name of the group. | ||
| + | **deleted - If the group is marked as deleted. If "0", the group is not marked as deleted. | ||
| + | **description - The description given for this group. | ||
| + | **short_name - The shortname for this group. | ||
| + | *{$site_groups_names} - An array that displays the names of your groups, in order of acending site ID. | ||
| + | *{$ site_groups_short} - An array that displays the shortnames of your groups, in order of acending site ID. | ||
| + | |||
== Notes == | == Notes == | ||
| Line 235: | Line 248: | ||
* [[nats_list_campaigns]] | * [[nats_list_campaigns]] | ||
* [[nats_list_sites]] | * [[nats_list_sites]] | ||
| + | |||
| + | [[Category:NATS4 Template Functions]] | ||
Latest revision as of 12:26, 18 June 2012
Applies to NATS 4.0.25 and greater.
nats_list_tours
Creates 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" |
| full version 4.0.71.1+ |
Do you want full details for the tour, instead of just the name | 1 or 0. You MUST also specify a site if you specify full | 0 | full="1" |
| 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, then each tour name starts with its shortname. For example:
1 => Array (1) 1 => "(MAIN) Default Tour" 2 => Array (1) 2 => "(MAIN) Default Tour"
If full is set, you will get a lot more data:
1 => Array (76) tourid => "1" tour => "MAIN" siteid => "1" networkid => "0" name => "Default Tour" url => "http://www.sitea.com" linkdomain => "join.instsitea.com" description => "This is the default tour for the Site A" thumb => "" thumb_ext => "" third_party_partner_id => "0" spartaurl => "" denyurl => "" denypost => "" approvalurl => "" approvalpost => "http://nats_install.testbed.toomuchme..." rebillpost => "" creditpost => "" chargebackpost => "" insufficient_fundpost => "" voidpost => "" userpost => "" userman => "" expirepost => "" custom => "" admin_signup_email => "" upgradeurl => "" upgradepost => "" allowed_lang => "" alternativeurl => "" allowed_lang_track_raw => "0" allowed_lang_track_unq => "0" hidden => "0" mail_member_joined => "" mail_member_cancelled => "" mail_member_rebilled => "" mail_member_credited => "" mail_member_chargedback => "" mail_member_insufficient => "" mail_member_voided => "" upgradedenyurl => "" upgradedenypost => "" prejoinpost => "" byo_owner => "0" byo_program => "0" byo_owner_only => "0" deleted => "0" niche => "" strack_programid => "0" mail_member_change => "" change_detailspost => "" created_date => "1259581534" mail_member_password => "Password Retrieval" credit_reversal_post => "" chargeback_reversal_post => "" void_reversal_post => "" insufficient_funds_reversal_post => "" mail_member_insufficient_reversal => "" mail_member_void_reversal => "" mail_member_credit_reversal => "" mail_member_chargeback_reversal => "" admin_threshold_email => "" mail_threshold => "" join_hit_threshold_hour_to_6 => "" join_hit_threshold_hour_to_12 => "" join_hit_threshold_hour_to_18 => "" join_hit_threshold_hour_to_24 => "" mail_member_pending_joined => "" mail_member_pre_joined => "" mail_member_pending_rebilled => "" mail_member_pre_rebilled => "" pre_approvalpost => "" pending_approvalpost => "" pre_rebillpost => "" pending_rebillpost => "" https_use => "1" 2 => Array (76) tourid => "2" tour => "byot" siteid => "1" networkid => "0" name => "BYO Tour" url => "http://www.sitea.com/byo" linkdomain => "" description => "" thumb => "" thumb_ext => "" third_party_partner_id => "0" spartaurl => "" denyurl => "" denypost => "" approvalurl => "" approvalpost => "" rebillpost => "" creditpost => "" chargebackpost => "" insufficient_fundpost => "" voidpost => "" userpost => "" userman => "" expirepost => "" custom => "" admin_signup_email => "" upgradeurl => "" upgradepost => "" allowed_lang => "" alternativeurl => "" allowed_lang_track_raw => "0" allowed_lang_track_unq => "0" hidden => "0" mail_member_joined => "" mail_member_cancelled => "" mail_member_rebilled => "" mail_member_credited => "" mail_member_chargedback => "" mail_member_insufficient => "" mail_member_voided => "" upgradedenyurl => "" upgradedenypost => "" prejoinpost => "" byo_owner => "0" byo_program => "0" byo_owner_only => "0" deleted => "0" niche => "" strack_programid => "0" mail_member_change => "" change_detailspost => "" created_date => "1259581537" mail_member_password => "Password Retrieval" credit_reversal_post => "" chargeback_reversal_post => "" void_reversal_post => "" insufficient_funds_reversal_post => "" mail_member_insufficient_reversal => "" mail_member_void_reversal => "" mail_member_credit_reversal => "" mail_member_chargeback_reversal => "" admin_threshold_email => null mail_threshold => "" join_hit_threshold_hour_to_6 => null join_hit_threshold_hour_to_12 => null join_hit_threshold_hour_to_18 => null join_hit_threshold_hour_to_24 => null mail_member_pending_joined => "" mail_member_pre_joined => "" mail_member_pending_rebilled => "" mail_member_pre_rebilled => "" pre_approvalpost => "" pending_approvalpost => "" pre_rebillpost => "" pending_rebillpost => "" https_use => "0"
Site Groups
There are three(3) arrays contained in the output that return site group information:
- {$site_groups} - Contains an array for each site group. Each group-specific array then contains:
- site_group_id - The ID# of the group.
- name - The full name of the group.
- deleted - If the group is marked as deleted. If "0", the group is not marked as deleted.
- description - The description given for this group.
- short_name - The shortname for this group.
- {$site_groups_names} - An array that displays the names of your groups, in order of acending site ID.
- {$ site_groups_short} - An array that displays the shortnames of your groups, in order of acending site ID.
Notes
To use full, you must also specify the site.
