Difference between revisions of "Nats list sites"
From TMM Wiki
Jump to navigationJump to searchm |
TmmStephen (talk | contribs) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 19: | Line 19: | ||
! Example | ! Example | ||
|- | |- | ||
| − | | | + | | program |
| The program's ID number | | The program's ID number | ||
| Any valid program ID number. | | Any valid program ID number. | ||
| Line 32: | Line 32: | ||
|- | |- | ||
| type | | type | ||
| − | | | + | | If 1, will display the site type along with the site name |
| − | | | + | | 0 or 1 |
| − | | Off; shows | + | | Off; shows only site name |
| − | | type=" | + | | type="1" |
|- | |- | ||
| [[assign_prefix]] | | [[assign_prefix]] | ||
| Line 42: | Line 42: | ||
| ''None.'' (No prefix is used) | | ''None.'' (No prefix is used) | ||
| assign_prefix="myvar" | | assign_prefix="myvar" | ||
| + | |- | ||
| + | | show_hidden <br> ''version 4.1+'' | ||
| + | | If 1, will display all of the sites whether hidden or not | ||
| + | | 0 or 1 | ||
| + | | Off; does not show hidden sites | ||
| + | | show_hidden="1" | ||
|} | |} | ||
| Line 181: | Line 187: | ||
* [[nats_list_campaigns]] | * [[nats_list_campaigns]] | ||
[[Category:DHUPDATE]] | [[Category:DHUPDATE]] | ||
| + | |||
| + | [[Category:NATS4 Template Functions]] | ||
Latest revision as of 22:44, 13 July 2011
Applies to NATS 4.0.25 and greater.
nats_list_sites
Stores in a Smarty array details about every site in a particular program.
Alias: list_sites
Parameters
(Required parameters in bold)
| Parameter | Description | Possible Values | Default Values | Example |
|---|---|---|---|---|
| program | The program's ID number | Any valid program ID number. | The default program ID number | programid="123" |
| full | Lists additional details about the sites. | 0 or 1 (exclusive) | Off; does not list additional details | full="1" |
| type | If 1, will display the site type along with the site name | 0 or 1 | Off; shows only site name | type="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" |
| show_hidden version 4.1+ |
If 1, will display all of the sites whether hidden or not | 0 or 1 | Off; does not show hidden sites | show_hidden="1" |
Output
Output placed in the Smarty array $sites. By default, the array will contain one field for each site name; for example:
Array (2) 1 => "Test site" 2 => "Test site 2"
If full is set, $sites will contain a multidimensional array; for example:
Array (2) 1 => Array (56) tourid => "1" tour => "MAIN" siteid => "1" networkid => "0" name => "Default Tour" url => "http://nats4.vodka.toomuchmedia.com/s..." linkdomain => "nats4.vodka.toomuchmedia.com" description => "" thumb => "" thumb_ext => "" third_party_partner_id => "0" spartaurl => "" denyurl => "" denypost => "" approvalurl => "http://www.yahoo.com.hk" approvalpost => "" rebillpost => "" creditpost => "" chargebackpost => "" insufficient_fundpost => "" voidpost => "" userpost => "" userman => "http://nats4.vodka.toomuchmedia.com/c..." expirepost => "" custom => "" admin_signup_email => "cho@toomuchmedia.com" upgradeurl => "" upgradepost => "" allowed_lang => "" alternativeurl => "" allowed_lang_track_raw => "0" allowed_lang_track_unq => "0" hidden => "0" mail_member_joined => "Member Join" mail_member_cancelled => "Member Cancel" mail_member_rebilled => "Member Rebill" mail_member_credited => "Member Credit" mail_member_chargedback => "Member Chargeback" mail_member_insufficient => "Member Insufficient Funds" mail_member_voided => "Member Void" upgradedenyurl => "" upgradedenypost => "" prejoinpost => "" byo_owner => "0" byo_program => "0" byo_owner_only => "0" deleted => "0" niche => "" strack_programid => "0" change_detailspost => "" mail_member_change => "Member Details Change" site_name => "Test site" site => "test" date_added => "1212465600" date_live => "0" strack_link => "http://nats4.vodka.toomuchmedia.com/s..." 2 => Array (56) tourid => "2" tour => "MAIN" siteid => "2" networkid => "0" name => "Default Tour" url => "" 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" change_detailspost => "" mail_member_change => "" site_name => "Test site 2" site => "test2" date_added => "1209960000" date_live => "0" strack_link => ""
Notes
None.
