{jr_downloads}
The {jr_downloads} template function is used for retrieving a list of users that have downloaded media files when the Jamroom Download Lock is being used. This can be used to create a list of users that can be embedded into any template that is NOT part of a Jamroom Theme. For the comparable function that can be used in Jamroom Profile Themes, please see {jr_theme_downloads}.
The {jr_downloads} Template Function is part of the Jamroom Power Pack.
Parameters:
Name |
Type |
Required |
Default |
Description |
template |
string |
yes |
n/a |
The "template" parameter tells Jamroom the name of the template you wish to use for displaying the output. |
band_id |
integer |
yes |
n/a |
The "band_id" parameter tells Jamroom the band_id to look for when gathering the list of users that have downloaded media. Only downloads from the given band_id will be shown. |
show |
integer |
no |
n/a |
If the "show" parameter is given, it will limit the number of users returned to the number given as "show". |
tpl_dir |
string |
no |
"theme" |
If the template you are going to use for processing is NOT located in the theme directory that the Profile is using, then you should specify "skin" for tpl_dir, and also provide the "skin" parameter. |
skin |
string |
no |
n/a |
If you are NOT using "theme" for the tpl_dir, then you should provide the name of the skin that contains the template file defined as "template". |
theme |
string |
no |
n/a |
The name of the theme can also be specified if you want to place the template file in a single theme directory and use it throughout all of your profile themes. |
assign |
string |
no |
n/a |
If the "assign" parameter is given, then the HTML code that is created by the {jr_downloads} function will be saved to the name given as "assign" and can be access later in the template as $name, where $name is the name of the variable given. |
Examples:
embedded {jr_downloads} function:
{jr_downloads band_id="5" template="downloads.tpl" tpl_dir="skin" skin="Cobalt"} |
Contents of downloads.tpl:
{foreach from=$DOWNLOADS item=_user}
{$_user.TIME|jr_date_format:"date1"} - {$_user.USER} - "{$_user.SONG_NAME}"<br>
{/foreach} |
Variables for use in the {jr_downloads} template:
Variable |
Description |
{$_user.TIME} |
The date/time (in epoch format) the user download the file. |
{$_user.USER} |
The User name that download the file. |
{$_user.SONG_ID} |
The song_id of the downloaded song. |
{$_user.SONG_NAME} |
The Song Name of the downloaded file. |
|