Carma top rated
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_top_rated
- Purpose: Display the top rated content available.
- Usage: {carma_top_rated count=5 section=1 type=any}
- Default Templates Used: top_rated_items
- Variables created: $carma_top_content, $params
Parameters
(Required parameters in bold)
Parameter | Description | Possible Values | Default Value | Example |
---|---|---|---|---|
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 |
section | get items from these sections | A comma-separated list of section ids or a specific section id | All sections | section="123" |
site | display content from the site with this site ID | A site I.D. number | All sites | site="123" |
type | which type of items to display: | gal, video, actor, or any | any | type="gal" |
tpl | Template used to display output | Any valid template | The top_rated_items template | tpl="my_template" |
easy_keys | Use continuous keys instead of keys based on the gallery ID for the $carma_content array | 1 | None. (Don't use continuous keys) | easy_keys="1" |
data_only | Set variables but don't display the template | 1 | None. The template is displayed. | data_only=1 |
assign_prefix | Prefix output variables with this word. (Click link for details) | Any valid Smarty variable name | None. (No prefix is used) | assign_prefix="myvar" |
assign | Store output in this variable | Any valid Smarty variable name | See output section below | assign="my_var" |
display_on_assign | display the template when using assigning | 1 | None. Template not displayed | display_on_assign="1" |
actors | Fetch the actors information for each gallery | 1 | None. Does not fetch the information | actors="1" |
locations | Fetch the locations information for each gallery | 1 | None. Does not fetch the information | locations="1" |
categories | Fetch the categories information for each gallery | 1 | None. Does not fetch the information | categories="1" |
groups | Fetch the groups information for each gallery | 1 | None. Does not fetch the information | groups="1" |
Description
This function displays the count top rated content sets of type for a given section or set of sections. It uses the top_rated_items template to display this information.