Ranking Orders
- Order by Event Time (newest to oldest) (default)
- Order by Event Time (oldest to newest)
- Order by Event Title (alphabetical)
- Order by Event Title (reverse alphabetical)
- Order by Event Location (alphabetical)
- Order by Event Location (reverse alphabetical)
- Order by Event Added Time (oldest to newest)
- Order by Event Added Time (newest to oldest)
- Order by Random
- Order by Event Rating Average (highest to lowest)
- Order by Event Rating Average (lowest to highest)
- Order by Event Rating Number (highest to lowest)
- Order by Event Rating Number (lowest to highest)
- Order by Event Comment Count (highest to lowest)
- Order by Event Comment Count (lowest to highest)
Additional Supported Parameters
In addition to the Common Function Parameters defined in the Jamroom Ranking System Guide, the "event" mode also supports the following additional parameters:
| PARAMETER |
TYPE |
DEFAULT |
DESCRIPTION |
| event_id |
number |
n/a |
The "event_id" parameter can be passed in so that only the given event_id entry will be shown. |
| location |
string |
n/a |
The "location" parameter tells Jamroom to only return events that are at a specific location. |
| min_ratings |
number |
n/a |
The "min_ratings" parameter tells Jamroom to only return events that have at least min_ratings number of User Ratings. |
| max_ratings |
number |
n/a |
The "max_ratings" parameter tells Jamroom to only return events that have less then max_ratings number of User Ratings. |
| min_average |
number |
n/a |
The "min_average" parameter tells Jamroom to only return events that have at least a min_average User Rating average. |
| max_average |
number |
n/a |
The "max_average" parameter tells Jamroom to only return events that have less then max_average User Rating average. |
| require_image |
true |
n/a |
If the "require_image" parameter is given, then only Event entries that have an associated image will be shown. |
| range |
number |
n/a |
If the "range" parameter is given, then only events that fall within the given range of days will show. As an example, a range of "15" would restrict the output to only events that have occurred in the past 15 days. |
| year |
number |
n/a |
If the "year" parameter is given, then only events scheduled in the given year will be shown. The value must be a 4 digit year greater then 2000. |
| month |
number |
n/a |
If the "month" parameter is given, then only events that are scheduled for the given month will be shown. Make sure and use in conjunction with a "year" parameter to restrict results to a single month. |
| day |
number |
n/a |
If the "day" parameter is given, then only events that are scheduled for the given numeric day will be shown. Make sure and use in conjunction with the "year" and "month" parameters to restrict results to a single day. |
| hour |
number |
n/a |
If the "hour" parameter is given, then only events that are scheduled for the given numeric hour (00 - 23) will be shown. Make sure and use in conjunction with the "year", "month" and "day" parameters to restrict results to a single hour. |
| old_events |
true |
n/a |
If the "old_events" parameter is set to "true", then events that have already passed will still be shown. |
| vault_only |
true |
n/a |
If the "vault_only" parameter is set to "true", then only events that have an associated Vault Item will be shown. |
Available search_area values
| SEARCH_AREA |
DESCRIPTION |
| event_title |
"event_title" will search the Event Title (event_title database column). |
| event_location |
"event_location" will search the Event Location (event_location database column). |
| event_description |
"event_description" will search the main Event Description (event_description database column). |
| event_all_fields |
event_all_fields will search the event_title, event_location and event_description fields. |
| event_???? |
Any Event 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 |
| {$EVENT_RANK} |
The numerical position on the output result set (starting at 1). |
| {$EVENT_ID} |
Jamroom Event ID for the entry |
| {$EVENT_TITLE} |
The Title of the Event |
| {$EVENT_LOCATION} |
The Location of the Event |
| {$EVENT_DESCRIPTION} |
The Description of the Event. |
| {$EVENT_ADDED} |
The 11 digit epoch time the Event was created. |
| {$EVENT_TIME} |
The 11 digit epoch time the Event is scheduled for. |
| {$EVENT_HOUR12} |
The 2 digit Hour the Event is scheduled for in 00 - 12 format (for use with AM/PM) |
| {$EVENT_HOUR24} |
The 2 digit Hour the Event is scheduled for in 00 - 24 format |
| {$EVENT_MINUTE} |
The minute portion of the timestamp the Event is scheduled for (00 - 60) |
| {$EVENT_DAY} |
The day the event is scheduled for in numerical form (00 - 31) |
| {$EVENT_MONTH} |
The month the event is scheduled for in numerical form (1-12) |
| {$EVENT_YEAR} |
The year the event is scheduled for in 4 digit format (i.e. 2007) |
| {$EVENT_AMPM} |
If you are using {$EVENT_HOUR12}, {$EVENT_AMPM} will be set to "am" if the {$EVENT_HOUR12} is less then 12, or "pm" if the {$EVENT_HOUR12} is 12 or greater. |
| {$EVENT_WDAY_SHORT} |
The day the event is scheduled on, in short abbreviation format (i.e. "Wed", "Fri", etc.). |
| {$EVENT_WDAY_LONG} |
The day the event is scheduled on, in long format (i.e. "Wednesday", "Friday", etc.). |
| {$EVENT_MONTH_SHORT} |
The month the event is scheduled for, in abbreviated format (i.e. "Jan", "Oct", etc.). |
| {$EVENT_MONTH_LONG} |
The month the event is scheduled for, in long format (i.e. "January", "October", etc.). |
| {$EVENT_IMAGE_URL} |
The HTML URL to use in an <img> tag to display the Event Image |
| {$EVENT_COMMENT_COUNT} |
The number of user comments for the Event |
| {$VAULT_CURRENCY_SYMBOL} |
If the Event has a Vault Item attached to it, you can use the {$VAULT_CURRENCY_SYMBOL} to display the proper currency symbol for the selected Vault Currency as set in the Payment Settings. |
|
