Jamroom Logo Jamroom 5 Core
is now Open Source!
Follow Jamroom on Twitter!

This document applies to Jamroom 3 only!
For current Jamroom 4 Documentation, visit the main Jamroom Documentation section.

Jamroom Ranking System - Store Mode Index Jamroom Ranking System - Vault Mode

Ranking Orders

  1. Order by User Name (alphabetical) (default)
  2. Order by User Name (reverse alphabetical)
  3. Order by User Created Date (oldest to newest)
  4. Order by User Created Date (newest to oldest)
  5. Order Randomly
  6. Order by User Rating Average (highest to lowest)
  7. Order by User Rating Average (lowest to highest)
  8. Order by User Rating Number (highest to lowest)
  9. Order by User Rating Number (lowest to highest)
  10. Order by Number of Friends/Fans (highest to lowest)
  11. Order by Number of Friends/Fans (lowest to highest)
  12. Order by Number of Profiles User Account is associated with (highest to lowest)
  13. Order by Number of Profiles User Account is associated with (lowest to highest)

 

Additional Supported Parameters

In addition to the Common Function Parameters defined in the Jamroom Ranking System Guide, the "user" mode also supports the following additional parameters:

PARAMETER TYPE DEFAULT DESCRIPTION
user_id  number n/a The "user_id" parameter tells Jamroom to only return the specified User ID(s).   Multiple User ID's may be specified either by Template array, or comma separated list.
letter string n/a If the "letter" parameter is given, then only Users that have an "Nickname" (i.e. login name) that begins with the given letter will be shown.
min_ratings number n/a The "min_ratings" parameter tells Jamroom to only return Users that have at least min_ratings number of User Ratings.
max_ratings number n/a The "max_ratings" parameter tells Jamroom to only return Users that have less then max_ratings number of User Ratings.
min_average number n/a The "min_average" parameter tells Jamroom to only return Users that have at least a min_average User Rating average.
max_average number n/a The "max_average" parameter tells Jamroom to only return Users that have less then max_average User Rating average.
require_image true n/a If the "require_image" parameter is given, then only User Accounts that have an associated image will be shown.
location string n/a The "location" parameter tells Jamroom to only return User Accounts that are associated with a Profile in the given location

 

Available search_area values

SEARCH_AREA DESCRIPTION
user_nickname "user_nickname" will search the "Nickname" (i.e. login name) of the User Account (user_nickname database column).
user_fullname "user_fullname" will search the "Full Name" of the User Account (user_fullname database column).
user_homepage "user_homepage" will search the "Homepage" User Account field (user_homepage database column).
user_imnumber "user_imnumber" will search the "User Instant Messenger Number" User Account field (user_imnumber database column).
user_address "user_address" will search the "Address" field of the User Account (user_address database column).
user_all_fields user_all_fields will search the user_nickname, user_fullname, user_homepage, user_imnumber and user_address fields.
user_???? Any User Custom Form fields are also searchable - consult the Custom Form Fields section of your Jamroom Config for details on the search_area name to use.

 

Template Variables for use in the row_template

In addition to the following Template Variables, you also have access to:

 

VARIABLE DESCRIPTION
{$USER_RANK} The numerical position on the output result set (starting at 1).
{$USER_ID} Jamroom User ID for the User Account
{$USER_BAND_ID} The Profile ID for the User Account.
{$USER_CREATED} The 11 digit epoch time for the User Account.
{$USER_UPDATED} The 11 digit epoch time for the User Account.
{$USER_LASTLOGIN} The 11 digit epoch time for the User Account.
{$USER_NICKNAME} The Nickname (i.e. Login Name) for the User Account
{$USER_FULLNAME} The Full Name of the User Account
{$USER_EMAILADR} The Email Address for the User Account.
{$USER_HOMEPAGE} The URL entered by the User Account into their User Profile for their "homepage".
{$USER_IMNUMBER} The value entered by the User as the "Instant Messenger" number in their Profile.
{$USER_IP} The IP Address the User  last logged in from.
{$USER_GENDER} The Gender of the user as selected in their Profile. 0 = "unknown", 1 = "male", 2 = "female"
{$USER_BIRTHDATE} The 11 digit epoch time for the Birth date the User has selected in their Profile.
{$USER_ADDRESS} The Address the User has entered into their Profile
{$USER_OCCUPATION} The value the User has entered into the "Occupation" field in their Profile.
{$USER_INTERESTS} The value the User has entered into the "Interests" field in their Profile.
{$USER_SHOW_EMAIL} Will be set to "0" if the User has chosen to NOT display their E-Mail Address, otherwise it will be set to "0".
{$USER_EDITOR} Will be set to "1" if the User is a Content Editor, otherwise set to "0".
{$USER_GLOBAL_EDITOR} Will be set to "1" if the User is a Global Content Editor, otherwise set to "0".

Jamroom Ranking System - Store Mode page 74 of 185 Jamroom Ranking System - Vault Mode
Solutions Products Support Community Company
Social Media Platform
Social Networking Software
Musician Website Manager
Community Builder
Jamroom 5
Jamroom 5 Modules
Jamroom Marketplace
Support Forum
Documentation
Support Center
Contact Support
Community Forum
Member Sites
Developers
About Us
Contact Us
Privacy Policy
©2003 - 2024 The Jamroom Network