Carma list favorites

From Tmmwiki

Jump to: navigation, search
CARMA
  Template Functions
carma_actor_photo_name
carma_comments_display
carma_comments_form
carma_count
carma_favorite
carma_get_extended
carma_list
carma_list_favorites
carma_list_gals
carma_list_third_party_content
carma_list_videos
carma_most_viewed
carma_newest
carma_news
carma_poll
carma_retrieve_sections
carma_search
carma_show_gal
carma_show_video
carma_top_actors
carma_top_rated
carma_upcoming
Template Function Aliases
carma_comment_display
carma_display_comment
carma_display_comments
carma_extended
carma_extended_data
carma_get_extended_data
carma_list_all


Contents

carma_list_favorites

Display a list of member's favorites on any template.

  • Sample Usage: {carma_list_favorites count=20 get='gals' type='videos' }
  • Required: none
  • Optional: type, get, section, sections_name, count, start, section, order, tpl, data_only, assign, display_on_assign
  • Version: CARMA 1.3.1.0 or higher

Input Variables

  • get: Type of favorites to list (all, gals, actors, custom. Lists all favorites by default)
  • type: When getting a content set, this can by any, gal, video, or story (Lists all types by default)
  • section_name: When getting a custom favorite list, this parameter can be use to limit the results by a specific section name.
  • count: How many items to display. (Default: 10)
  • start: Which item to start at. (Default: 0)
  • var: overwrite the default variable name for the favorites data.
  • section: When display a favorite content list, this will limit the the content to the sections in this list.
  • tpl: Specify another template to use instead of the default template for this function.
  • data_only: Set to 1 if you want to only store the data for later use. (Default: 0/false)
  • assign: String to use for a variable that holds the output of the function. Leave blank to not store the output.
  • display_on_assign: Set to 1 if you want to still display the template when using assign.
  • Default Templates Used: favorites_list
  • Variables created: $carma_favorites

Description

This function displays a list of a member's favorites. It will put the data into the $carma_favorites variable which contains a sub array for each favorite type. Each type also contains a count variable that hold the total amount of this specific favorite in the system.

  • $carma_favorites.gals
  • $carma_favorites.gals_count
  • $carma_favorites.actors
  • $carma_favorites.actors_count
  • $carma_favorites.custom
  • $carma_favorites.custom_count

Related

carma_favorite

Personal tools
products