Carma favorite

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_favorite

Display a link to allow a member to add or remove a favorite.

  • Sample usage: {carma_favorite galid=$smarty.entry.galid}
  • Required: caption and one of: galid, actorid, or section_name
  • Optional: tpl, var, data_only, assign, display_on_assign
  • Version: CARMA 1.3.1.0 or higher

Input Variables:

  • galid: Set this to the gallery ID number you want a member to add or remove. You can use the variables $galid or $smarty.request.galid.
  • actorid: Set this to the actor's ID number you want a member to add or remove
  • section_name: Custom favorite list section name
  • caption: The unique name for this custom favorite.
  • var: set the variable name for the favorites data.
  • tpl: Specify another template to use instead of the default template for this function.
  • data_only: Set to 1 to store the data for later use. The default, 0/false, will print the link.
  • assign: String to use for a variable that holds the output of the function. Leave blank to store no output.
  • display_on_assign: Set to 1 if you want to display the template when using assign. The default, 0/false, will not display the template when you use assign.
  • Default Templates Used: favorite
  • Variables created: $carma_favorite

Description

This function displays an add favorite link for to members for galleries, actors, or sections that they haven't made a favorite yet. If the user already made the gallery a favorite, this link will remove the favorite. You need to use pass an argument containing either the actor's ID number, the gallery ID number, or the section name to make a favorite.

Related

Personal tools
products