{jr_array}
{jr_array} is used within a Jamroom template to assign indexes and values to a template array. This is most commonly used to prepare an array for use in the {jr_ranking}, {jr_chart}, and other embeddable custom functions.
Parameters:
| Name |
Type |
Required |
Default |
Description |
| name |
string |
yes |
n/a |
the name of the template array the key -> index value will be added to. If the array does not exist, the function will create it. |
| key |
string |
yes |
n/a |
name of key (index) to add to array |
| value |
string |
yes |
n/a |
value to assign to key (index) in named array |
| explode |
yes/no |
no |
no |
If the explode parameter is given, then Jamroom will run the PHP explode() function on the value before assigning the results to the array. The default explode separator is a comma (,). |
| separator |
string |
no |
, |
If you would like explode to use a different separator, you can define that in the separator param. |
Example:
Example using {jr_array} to prep the "band_id" array and passing it to the {jr_ranking} embedded function:
{jr_array name="band_id" key="0" value="25"}
{jr_array name="band_id" key="1" value="36"}
{jr_array name="band_id" key="2" value="51"}
{jr_ranking mode="spotlight" band_id=$band_id} |
Example:
Example using {jr_array} to explode a comma separated list and pass it to the {jr_ranking} embedded function:
{jr_array name="genre" value=$BAND_GENRE explode="yes"}
{jr_ranking mode="artist" genre=$genre} |
|
