Nats list options

From TMMwiki
Jump to: navigation, search
NATS 4
    Template Functions
nats_add_to_array
nats_adtool_replace_linkcode
nats_array_flip
nats_array_to_xml
nats_build_array_by_reference
nats_convert_bytes
nats_decode
nats_display_account_campaigns
nats_display_account_change_history
nats_display_account_notifications
nats_display_account_preview
nats_display_admin_links
nats_display_admin_message
nats_display_adtool_form
nats_display_adtool_types
nats_display_adtools
nats_display_adtools_type_limit
nats_display_choose_adtools_group
nats_display_code_info
nats_display_create_campaign
nats_display_edit_account_details
nats_display_edit_account_settings
nats_display_edit_defaults
nats_display_edit_password
nats_display_edit_payvia
nats_display_edit_payvia_info
nats_display_edit_skin
nats_display_gallery_builder
nats_display_graph
nats_display_hourly_sales
nats_display_latest_adtools
nats_display_map
nats_display_news
nats_display_page_peel
nats_display_payment_history
nats_display_payment_summary
nats_display_ratio
nats_display_reward_category
nats_display_reward_order
nats_display_reward_purchases
nats_display_signup_advanced
nats_display_signup_basic
nats_display_signup_payvia
nats_display_stats
nats_display_stats_calendar
nats_display_stats_form
nats_display_stats_referrals
nats_display_stats_retention
nats_display_stats_subscription_details
nats_display_stats_table
nats_display_timezones
nats_display_top_stats
nats_dump_data
nats_encode
nats_get_first_in_array
nats_get_period_end
nats_get_reward_categories
nats_get_member
nats_list_adtool_groups
nats_list_affiliates
nats_list_billers
nats_list_campaigns
nats_list_linkcodes
nats_list_options
nats_get_option_details
nats_list_programs
nats_list_sites
nats_list_tool_categories
nats_list_tours
nats_list_xsells
nats_smarty_function_amount_owed
nats_smarty_function_getbonus
nats_smarty_rebuild_form
nats_smarty_rebuild_link
nats_smarty_rebuild_query
nats_tooltip
nats_track_link
nats_strack_link
tmm_admin_pagination
Template Shortcuts
add_to_array
adtool_replace_linkcode
affiliate_select_form
array_flip
array_to_xml
amount_owed
build_array_by_reference
convert_bytes
display_account_campaigns
display_account_change_history
display_account_notifications
display_account_preview
display_admin_links
display_adtool_form
display_adtool_types
display_adtools
display_adtools_type_limit
display_choose_adtools_group
display_code_info
display_create_campaign
display_gallery_builder
display_stats_referrals
display_edit_account_details
display_edit_account_settings
display_edit_defaults
display_edit_password
display_edit_payvia
display_edit_payvia_info
display_edit_skin
display_graph
display_hourly_sales
display_latest_adtools
display_map
display_news
display_page_peel
display_payment_history
display_payment_summary
display_ratio
display_reward_category
display_reward_order
display_reward_purchases
display_signup_advanced
display_signup_basic
display_signup_payvia
display_stats
display_stats_calendar
display_stats_table
display_stats_form
display_stats_retention
display_stats_subscription_details
display_top_stats
display_timezones
dump_data
get_first
get_period_end
get_reward_categories
list_billers
list_campaigns
list_linkcodes
list_options
list_programs
list_sites
list_tool_categories
list_tours
list_xsells
rebuild_form
rebuild_link
rebuild_query
reward_points
tooltip
Common Parameters
assign
assign_prefix
count
data_only
display_on_assign
start
tpl

nats_list_options

Stores a list of all the available join options for a site in the {$options} Smarty variable.

Alias: list_options

Parameters

(Required parameters in bold)

Parameter Description Possible Values Default Value Example
site The I.D. number of the site to get join options for Any valid site I.D. number The default site I.D. number site="123"

Output

A list of all the available join options for a site in the {$options} Smarty variable. A list of option details for a site in the {$options_details} Smarty variable.


Notes

You can use the list_options function to add more information (Ex: price) to the Join Page for each site.

By calling {list_options site=1} in your template, you can populate the $options array, and the $option_details array with all the join options available for site 1. An example of the contents of these arrays is as follows.

$option_details

Array (2)
4 => Array (14)
  optionid => "4"
  siteid => "5"
  networkid => "0"
  deleted => "0"
  enabled => "1"
  orderid => "1"
  option_type_id => "0"
  billerid => "0"
  programid => "0"
  initial => "10"
  initial_days => "30"
  rebill => "5"
  rebill_days => "30"
  name => "Our most popular service!"
5 => Array (15)
  optionid => "5"
  siteid => "5"
  networkid => "0"
  deleted => "0"
  enabled => "0"
  orderid => "2"
  option_type_id => "0"
  billerid => "0"
  programid => "0"
  initial_free => "1"
  initial => "100"
  initial_days => "2"
  rebill => "60"
  rebill_days => "30"
  name => "Our next most popular service"

$options

Array (2)
4 => "Our most popular service!"
5 => "Our next most popular service!"

The arrays generated by {list_options} will contain all the join options for a given site, regardless of whether they satisfy the display rules. If you need to access the join options that satisfy the join option rules, you can use the $join_options array. This will contain the name of all the join options that satisfy the join option rules. An example of its contents are follows:

Array (1)
4 => "Our most popular service!"

Example

For example, to add the price of each join option next to its description you can edit the join page template as follows.
Replace the line below:
{html_options options=$join_options selected=$vars.optionid}
with:

        {list_options site=$site}
	{foreach from=$join_options key=k item=v}
		<option>{$v} - ${$option_details[$k].initial}</option>
		{*shows the description of the join_option followed by a '-', followed by the initial price of the join option*}
	{/foreach}

Instead of displaying "Our most popular service" in the list box, this will display "Our most popular service - $10".