Carma list favorites
From TMM Wiki
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
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
Parameters
(Required parameters in bold)
Parameter | Description | Possible Values | Default Value | Example |
---|---|---|---|---|
get | Type of favorites to list | all, gals, actors, custom | all | get="actors" |
type | Type of content set to get | any, gal, video, or story | any | type="gal" |
section_name | Limit the results by a specific section name | Any section name | None | section_name="my_name" |
count | Maximum number of results to display (Click link for details) | Zero or any whole number greater than zero | 10 | count=20 |
start | Hide all results lower than this number (Click link for details) | Any whole number greater than zero | None. (Doesn't hide any results) | start=10 |
var | Put the favorites data in this variable name | Any valid Smarty variable name | carma_favorites | var="my_variable" |
section | Limit the content to this section | Any section I.D. | None. | section="123" |
tpl | Display favorites using this template | Any valid template name | favorites_list (Display favorites using the favorites_list template) | tpl="my_template" |
data_only | Put the favorites in an array | 1 | None. Displays favorites | data_only=1 |
assign | Name of the Smarty variable that stores the output | Any valid Smarty variable name | None. Output is displayed, not stored | assign="my_var" |
display_on_assign | Display favorites even when the assign parameter (above) is used | 1 | None If assign is used, no favorites are displayed | display_on_assign=1 |
- 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