Member Favorites

CARMA About CARMA CARMA Requirements CARMA Changelog Setup Setting Up CARMA MySQL Settings Add Site Porting Sites to CARMA Moving CARMA Sites Admin The Sites Admin Site Sections Publish Mode Content Set Schedule Templates Admin Members Area Templates Tour Templates Member Favorites Smarty Loops Smarty Caching Smarty print array Base Templates User Variables Rating System   Template Functions CARMA Template Functions carma_actor_photo_name carma_comments_display carma_comments_form carma_count carma_favorite carma_gal_custom carma_get_extended carma_list carma_list_favorites carma_list_gals carma_list_third_party_content carma_list_videos carma_login_log carma_most_viewed carma_newest carma_news carma_poll carma_retrieve_sections carma_search carma_actors_search carma_show_gal carma_show_video carma_top_actors carma_top_rated carma_upcoming print_page_numbers Template Function Aliases carma_comment_display carma_display_comment carma_display_comments carma_extended carma_extended_data carma_get_extended_data carma_list_all Common Parameters assign assign_prefix count data_only display_on_assign start tpl Schedule Admin The Schedule Admin Scheduling Content Content Set Schedule Calendar Snapshot News Admin The News Admin Add News Auto News Feedback Admin The Feedback Admin The Polls Admin Gallery Content Admin The Gallery Content Admin Adding Content Edit Image Adding Image Text Content Set Locations Content Set Categories Managing Thumbnails Watermarking Image Removal Image Order Rotate Image Image Quality Video Content Admin The Video Content Admin Adding Content Video Clips Out of Order Video Thumbnails Content Set Locations Content Set Categories Video Format Flash Player Generate Flash Videos Using mp4 Videos Video Content Names Thumbnails Admin The Thumbnails Admin Image Thumbnail Video Thumbnails Third Parties Admin Third Party Content Scan Content Admin Scan Content Actors Admin The Actors Admin Add Actor Actor Photos Actor Documents Manage Attribute Types Creating Actor Pages Members Admin The Members Admin Member Details Stats Admin The Stats Admin Site Statistics Member's Statistics Content Statistics Actor's Statistics Accounts Admin Accounts Admin Add Account Access Levels Configuration Admin The Configuration Admin CARMA Configuration Variables Video Format Troubleshooting Common Errors Extras The Support Admin Admin Areas CARMA Home Pseudo Streaming Flash Player Using mp4 Videos Zipping Content Third Party Content X-Sendfile Xmoov-php TMMid

As of CARMA 1.3.1.0, members can use template functions which let them mark favorites in your site(s). These favorites can be videos, photos, actors, or custom tags.

The two template functions that allow members to mark favorites are carma_favorite and carma_list_favorites. These functions can only be used in CARMA 1.3.1.0 or higher; if you cannot access these templates, please submit an upgrade ticket for your CARMA install.

Add/Removing Favorites

The carma_favorite template function allows members to mark content as a favorite, outputting a link that allows them to either add or delete the selected content to/from their favorites. This function uses the favorite template for its output by default.

Examples

For favorite videos and photos:

{carma_favorite galid=$galid}
{carma_favorite galid=$smarty.request.galid}
{carma_favorite galid=42}

For favorite actor:

{carma_favorite actorid=11}

To create a custom favorite:

{carma_favorite section_name=”fav_type” caption=”title” data=”anything you want here”}

The section_name and caption fields are required in order to use custom favorites. The data field can be set to any Smarty variable.

For example: if you want to bookmark a page, you can set the data field to that page's URL and set caption to the page's title. The value for section_name differs for each group of favorites you're tracking. For example, you can have separate sections for clips and for photos, allowing you to track each member's favorite clips separately from their favorite photos.

To bookmark the current page:

{capture name=link}
http://{$smarty.server.HTTP_HOST}{rebuild_link encode=1}
{/capture}
{carma_favorite section_name='clips' caption=$filename data=$smarty.capture.link}

You can also use the sample code above to create a list of all video clips a member has saved to favorites, instead of making the entire video set a favorite list.

Listing Favorites

The carma_list_favorites function allows you to display a chosen member's favorite content. You can use this function to output all content set to favorites by the member, or to output only a single favorite type (for example, videos, photos, etc). The output of this folder is controlled by the template list by default.

Examples

To output all member's favorites:

{carma_list_favorites}

To output all content favorites (video and photo sets):

{carma_list_favorites get='gals'}

To output all photo set favorites:

{carma_list_favorites get='gals' type='gal'}

To output all video set favorites:

{carma_list_favorites get='gals' type='video'}

To output all actor favorites:

{carma_list_favorites get='actors'}

To output all custom favorites:

{carma_list_favorites get='custom'}

To output all custom favorites with section tag of clips:

{carma_list_favorites get='custom' section_name='clips'}

See Also

For more information on the available parameters for these two template functions, please refer to the following articles:

• carma_favorite
• carma_list_favorites