JReviews comes with 9 modules and all of them are installed automatically when installing JReviews. To use any of the modules, go to the Joomla Module Manager and publish the module to one of the module positions that your Joomla template provides.
The Listings Module can be used for displaying:
Example of the module layout:
Listings Ordering - choose what the module will display:
Radius for Proximity Ordering - used if Proximity is selected in Listing Ordering parameter.
Show Distance for Proximity Ordering - used if Proximity is selected in Listing Ordering parameter.
Show Summary - here you can enable displaying listing summary text in the module.
Summary Words - how many words of the summary text to show.
Show Listing Category - here you can enable displaying the listing category.
Comma separated list of custom fields to show (i.e. jr_state,jr_city) - enter the names of custom fields that you want to show in the module.
Show Editor Rating - here you can enable displaying the editor rating.
Show User Rating - here you can enable displaying the user rating.
JReviews Theme Suffix - this suffix will be applied to the module view file and is useful to create multiple instances of the module that have different outputs. Two alternative theme files with suffixes for the Listings Module come by default with JReviews: _slideshow and _vertical.
Show Thumbnail - enable or disable displaying the main media thumbnail.
Thumbnail Position - (Left | Right | Top | Bottom)
Thumbnail Mode - (Scale | Crop)
Size (WIDTHxHEIGHT) - WIDTHxHEIGHT in pixels. This can be considered as "maximum width" and "maximum height" for the thumbnail.
Everywhere Extension - this is a universal module that works not only with core JReviews listings, but also with 3rd party components integrated via the Everywhere Add-on. The module can only display listings from one component at a time, so you need to enter the component's name here (i.e. com_content, com_sobi2, com_k2, etc.)
Category Autodetect - JReviews will try to determine the category id and show only results for that category. If enabled, this setting overrides all the ID settings below it.
Directory IDs (com_content) - filter listings by directory IDs.
Category IDs (everywhere) - filter listings by category IDs.
Listing IDs (everywhere) - display listings based on specific listing IDs.
With Custom WHERE and Custom ORDER BY parameters you can display listings based on the custom sql commands. Read about Custom WHERE and Custom ORDER BY.
Positioning of Pagination - choose the position of slider arrows when the module has multiple slider pages.
Page Transition - choose the transition type for the slider pagination (Horizontal sliding | Vertical sliding | Fade effect).
Enable Slideshow - if enabled, the module will automatically advance slider pages.
Slideshow Interval (sec.) - time between pages in seconds.
Max. number of results - total number of results that will be displayed.
Results per page - how many results will be displayed per slider page. If you enter the same number as for Max. number of results, then the module slider will be disabled and all results will be displayed at once.
Columns - choose how many results per row to show.
Show numbers - adds numbers before each result.
Submitted in past x days - with this setting you can filter the results to use listings submitted in the past x days. The setting works for all modes.
With reviews submitted in past x days - will display listings that had reviews submitted in the past x days.
Review count higher than - filters the results to listings with having at least the defined number of reviews.
Avg rating higher than - filters the results to listings with having at least the defined average rating.
Enable Compare Button - displays the Compare button in listings (only if listing comparison is enabled in global JReviews configuration as well).
Example of the _slideshow layout:
To use this layout, enter "_slideshow" in the Theme Suffix parameter.
Example of the _vertical layout:
To use this layout, enter "_vertical" in the Theme Suffix parameter.
If you want to customize the theme file of the Listings Module, this is its default location:
/com_jreviews/jreviews/views/themes/default/modules/listings.thtml
Before you start customizing the theme files, make sure you read about JReviews Code Overrides functionality and create a custom theme.
There are two alternative theme files for the Listings Module:
/com_jreviews/jreviews/views/themes/default/modules/listings_slideshow.thtml
/com_jreviews/jreviews/views/themes/default/modules/listings_vertical.thtml
To use one of those, enter the theme file suffix in the Theme Suffix parameter. The same way you can create multiple custom copies of the Listings Module theme file. Remember to clear JReviews File Registry when creating new theme files.
The Reviews Module can be used for displaying:
Example of the module layout:
Reviews Ordering - choose how the reviews will be ordered:
Review Type - choose to show All reviews or only Editor/User reviews.
Title Format - you can use the {listing_title} and {review_title} tags to build your link title output. You can also specify the total number of characters to show (including the ... at the end), by adding the number inside the tag like this {listing_title 10} - {review_title 15}.
Show Review Comments - here you can enable displaying the review comments text in the module.
Trim Comments (# words) - how many words of the comments text to show.
Comma separated list of custom fields to show (i.e. jr_pros,jr_cons) - enter the names of the review custom fields that you want to show in the module.
JReviews Theme Suffix - this suffix will be applied to the module view file and is useful to create multiple instances of the module that have different outputs.
Show Thumbnail - enable or disable displaying the main media thumbnail.
Thumbnail Position - (Left | Right | Top | Bottom)
Thumbnail Mode - (Scale | Crop)
Size (WIDTHxHEIGHT) - WIDTHxHEIGHT in pixels. This can be considered as "maximum width" and "maximum height" for the thumbnail.
Everywhere Extension - this is a universal module that works not only with reviews of core JReviews listings, but also with reviews of 3rd party component listings integrated via the Everywhere Add-on. The module can only display reviews from one component at a time, so you need to enter the component's name here (i.e. com_content, com_sobi2, com_k2, etc.)
Category Autodetect - JReviews will try to determine the category id and show only results for that category. If enabled, this setting overrides all the ID settings below it.
Directory IDs (com_content) - filter reviews by directory IDs.
Category IDs (everywhere) - filter reviews by category IDs.
Listing IDs (everywhere) - display reviews based on specific listing IDs.
With Custom WHERE and Custom ORDER BY parameters you can display reviews based on the custom sql commands. Read about Custom WHERE and Custom ORDER BY.
Positioning of Pagination - choose the position of slider arrows when the module has multiple slider pages.
Page Transition - choose the transition type for the slider pagination (Horizontal sliding | Vertical sliding | Fade effect).
Enable Slideshow - if enabled, the module will automatically advance slider pages.
Slideshow Interval (sec.) - time between pages in seconds.
Max. number of results - total number of results that will be displayed.
Results per page - how many results will be displayed per slider page. If you enter the same number as for Max. number of results, then the module slider will be disabled and all results will be displayed at once.
Columns - choose how many results per row to show.
Show numbers - adds numbers before each result.
If you want to customize the theme file of the Reviews Module, this is its default location:
/com_jreviews/jreviews/views/themes/default/modules/reviews.thtml
Before you start customizing the theme files, make sure you read about JReviews Code Overrides functionality and create a custom theme.
You can create multiple custom copies of the Reviews Module theme file and enter their suffixes in the Theme Suffix parameter. Remember to clear JReviews File Registry when creating new theme files.
With the Advanced Search Module you can create a customized search form with custom fields of you choice.
Example of the default module layout:
Example of the module layout after adding custom fields:
JReviews Theme Suffix - this suffix will be applied to the module view file and is useful to create multiple instances of the module that have different outputs. The module comes with one default suffix "_map" which includes the address and radius fields, you should enter this suffix if you use the GeoMaps add-on.
Specify Itemid of JReviews menu for result url - by default the search result page will inherit an Itemid of the JReviews Advanced Search menu item. Here you can override this to a different menu item if you want.
Theme Suffix for search results page - here you can apply a custom theme suffix for the search results page.
Category Autodetect - if category is detected, the category list will display only that category and its subcategories. If enabled, this setting overrides all the ID settings below it.
Directory IDs (comma list) - limits options shown in category list.
Listing Type IDs IDs (comma list) - limits options shown in category list.
Category IDs (comma list) - limits options shown in category list.
Enable Module Theme - this option allows you to add additional custom fields to the module without customizing the module's theme file.
There are two ways to create your custom forms for the Advanced Search Module. The first and simplest one is by using the module settings. The second one requires modifying the module theme file.
If you choose to use the module settings, head over to the Joomla Module Manager and click on the Advanced Search Module to edit it. You'll find the Theme Customization Settings section towards the bottom of the 'Basic Options'. Change 'Enable Module Theme' to Yes and paste the starter theme code below in the textarea:
<div class="jrFieldDiv jrLeft">
{category_label}: {category}
</div>
<div class="jrFieldDiv jrLeft">
{keywords_label}: {keywords}
</div>
<div class="jrFieldDiv jrLeft">
<button class="jr-search jrButton">
<span class="jrIconSearch"></span><span>Search</span>
</button>
</div>
This method requires modifying the advanced search module theme file which is located here:
\com_jreviews\jreviews\views\themes\default\modules\advanced_search.thtml
Before you start customizing the theme file, make sure you read about JReviews Code Overrides functionality and create a custom theme.
This is the code that displays default elements of the module:
<div class="jrFieldDiv jrLeft">
<?php __t("Category");?>: {category}
</div>
<div class="jrFieldDiv jrLeft">
<?php __t("Keywords");?>: <input type="text" class="jrText" name="data[keywords]" value="<?php echo Sanitize::getString($this->params,'keywords');?>" />
</div>
<div class="jrFieldDiv jrLeft">
<button class="jr-search jrButton">
<span class="jrIconSearch"></span><span>Search</span>
</button>
</div>
If you need multiple advanced search modules, then you also need multiple versions of the file. Use the Theme Suffix setting in the module while also creating copies of the theme files as explained below.
Theme Suffix Examples:
advanced_search_movies.thtml - enter "_movies" as Advanced search theme suffix in the module's parameters.
advanced_search_hotels.thtml - enter "_hotel" as Advanced search theme suffix in the module's parameters.
When you add a new file to JReviews folders, you need to clear the File Registry in JReviews administration.
To add your custom fields into the form, use these tags:
For example, to add a jr_brand custom field, you would use this code in the theme file:
<div class="jrFieldDiv jrLeft">
<?php __t("Category");?>: {category}
</div>
<div class="jrFieldDiv jrLeft">
{jr_brand_label}: {jr_brand}
</div>
<div class="jrFieldDiv jrLeft">
<?php __t("Keywords");?>: <input type="text" class="jrText" name="data[keywords]" value="<?php echo Sanitize::getString($this->params,'keywords');?>" />
</div>
<div class="jrFieldDiv jrLeft">
<button class="jr-search jrButton">
<span class="jrIconSearch"></span><span>Search</span>
</button>
</div>
If you use the module settings, the code would look like this:
<div class="jrFieldDiv jrLeft">
{category_label}: {category}
</div>
<div class="jrFieldDiv jrLeft">
{jr_brand_label}: {jr_brand}
</div>
<div class="jrFieldDiv jrLeft">
{keywords_label}: {keywords}
</div>
<div class="jrFieldDiv jrLeft">
<button class="jr-search jrButton">
<span class="jrIconSearch"></span><span>Search</span>
</button>
</div>
{jr_brand_label}: {jr_brand} was added into the default code.
Use the same process to add your other custom fields.
You can use the Directories module to display the complete directory/category navigation tree.
Example of the module layout:
JReviews Theme Suffix - this suffix will be applied to the module view file and is useful to create multiple instances of the module that have different outputs. The module comes with one default suffix "_folders" which will add folder icons next to the links.
Directory IDs (optional) - here you can choose to show only specific directories by entering their ID numbers. ID numbers of directories can be found in JReviews Directories Manager.
Show Directory Links - if disabled, the module will hide directory links and show only category links.
If you want to customize the theme file of the Directories Module, this is its default location:
/com_jreviews/jreviews/views/themes/default/modules/directories.thtml
Before you start customizing the theme files, make sure you read about JReviews Code Overrides functionality and create a custom theme.
You can create multiple custom copies of the Directories Module theme file and enter their suffixes in the Theme Suffix parameter. Remember to clear JReviews File Registry when creating new theme files.
The Fields Module shows a clickable list of options for a chosen field. When visitors click on a certain link, they will get a search results page with a list of listings that have that field value.
Example of the module layout:
Field name (i.e. jr_fieldname) - this parameter is required. Enter the name of the custom field whose field options you want the module to display. Only field types for which you created field options in the Fields Manager can be used.
JReviews Theme Suffix - this suffix will be applied to the module view file and is useful to create multiple instances of the module that have different outputs.
Itemid selection - you can control the itemid used for the field option links so that modules on the current page are seen on the result list or not.
Itemid - used only if you selected Use Itemid below in the above parameter.
Display mode - choose how the field options will be displayed:
Field option ordering - choose how the field options will be ordered.
Limit option text to x chars - here you can set a maximum number of characters that field options will display.
Before text - this text will appear before the list. You can use html tags.
Category Auto Detect - if a category is found for the page, the results will be limited to that category. If no category is found then the module will use the listing type and category settings below if they are set.
Listing Type ID (single value) - limit results to all categories with the same listing type.
Category IDs (comma list) - separate values with comma. Limit results to specified categories. No need to specify listing type id above.
Custom URL parameters - add any other custom search parameters you want. This could be custom field filters (i.e. jr_brand:canon) or custom ordering (order:jr_price).
Links horizontal
Links vertical
Tags
Dropdown list
If you want to customize the theme file of the Fields Module, this is its default location:
/com_jreviews/jreviews/views/themes/default/modules/fields.thtml
Before you start customizing the theme files, make sure you read about JReviews Code Overrides functionality and create a custom theme.
You can create multiple custom copies of the Fields Module theme file and enter their suffixes in the Theme Suffix parameter. Remember to clear JReviews File Registry when creating new theme files.
The Range Module shows a clickable list of numeric range options for a chosen custom field. It is mostly used for Price Range links. When visitors click on a certain link, they will get a search results page with a list of listings that belong to that price range.
Example of the module layout:
Field name (i.e. jr_fieldname) - this parameter is required. Enter the name of the numeric custom field that will be used to performe range searches.
Ranges (0-100+100-200+200-300+300) - enter the numeric ranges in the specified format. The last value without an upper range will be used to show all numbers above that value.
JReviews Theme Suffix - this suffix will be applied to the module view file and is useful to create multiple instances of the module that have different outputs.
Itemid selection - you can control the itemid used for the field option links so that modules on the current page are seen on the result list or not.
Itemid - used only if you selected Use Itemid below in the above parameter.
Display mode - choose how the field options will be displayed:
Option Prefix - use for units, currency, etc.
Option Suffix - use for units, currency, etc.
Range separator - goes in between the numbers in the range.
Before text - this text will appear before the list. You can use html tags.
Category Auto Detect - if a category is found for the page, the results will be limited to that category. If no category is found then the module will use the listing type and category settings below if they are set.
Listing Type ID (single value) - limit results to all categories with the same listing type.
Category IDs (comma list) - separate values with comma. Limit results to specified categories. No need to specify listing type id above.
Custom URL parameters - add any other custom search parameters you want. This could be custom field filters (i.e. jr_brand:canon) or custom ordering (order:jr_price).
Links horizontal
Links vertical
Tags
Dropdown list
If you want to customize the theme file of the Range Module, this is its default location:
/com_jreviews/jreviews/views/themes/default/modules/range.thtml
Before you start customizing the theme files, make sure you read about JReviews Code Overrides functionality and create a custom theme.
You can create multiple custom copies of the Range Module theme file and enter their suffixes in the Theme Suffix parameter. Remember to clear JReviews File Registry when creating new theme files.
The Media Module can be used for displaying photos, videos, audio files and attachments based on how you configure the module parameters:
Example of the module layout:
Media Type - choose which media type the module will display:
Media Ordering - choose how the media item swill be sorted.
JReviews Theme Suffix - this suffix will be applied to the module view file and is useful to create multiple instances of the module that have different outputs.
Type - (Scale | Crop)
Size (WIDTHxHEIGHT) - WIDTHxHEIGHT in pixels. This can be considered as "maximum width" and "maximum height" for the thumbnail.
Show Media Type Icon - if enabled, a small icon will be displayed in top right corner of the thumbnail for visitors to know which type of media the thumbnail represents.
Everywhere Extension - if you want to limit results to a specific extension, then enter it here (i.e. com_content, com_virtuemart, com_sobi2, etc.). Only ONE extension at a time!
Display Media Uploaded By - choose if you want to display media uploaded by listing owners, by users or both.
Category Autodetect - filters results for current category.
Directory IDs (com_content) - filter media by directory IDs.
Category IDs (everywhere) - filter media by category IDs.
Listing IDs (everywhere) - display media based on specific listing IDs.
With Custom WHERE and Custom ORDER BY parameters you can display media based on the custom sql commands. Read about Custom WHERE and Custom ORDER BY.
Positioning of Pagination - choose the position of slider arrows when the module has multiple slider pages.
Page Transition - choose the transition type for the slider pagination (Horizontal sliding | Vertical sliding | Fade effect).
Enable Slideshow - if enabled, the module will automatically advance slider pages.
Slideshow Interval (sec.) - time between pages in seconds.
Max. number of results - total number of results that will be displayed.
Results per page - how many results will be displayed per slider page. If you enter the same number as for Max. number of results, then the module slider will be disabled and all results will be displayed at once.
Columns - choose how many results per row to show.
Show numbers - adds numbers before each result.
If you want to customize the theme file of the Media Module, this is its default location:
/com_jreviews/jreviews/views/themes/default/modules/media.thtml
Before you start customizing the theme files, make sure you read about JReviews Code Overrides functionality and create a custom theme.
You can create multiple custom copies of the Media Module theme file and enter their suffixes in the Theme Suffix parameter. Remember to clear JReviews File Registry when creating new theme files.
The Favorite Users Module displays a list of users who've added the listing being viewed to their favorites list.
If enabled, the module will display user avatars together with their names. The module works with avatars from EasySocial, JomSocial or Community Builder.
The Favorite Users Module should be enabled only for listing detail pages.
Example of the module layout:
JReviews Theme Suffix - this suffix will be applied to the module view file and is useful to create multiple instances of the module that have different outputs.
Only users with avatars - users that haven't uploaded their custom avatars will be hidden.
Positioning of Pagination - choose the position of slider arrows when the module has multiple slider pages.
Page Transition - choose the transition type for the slider pagination (Horizontal sliding | Vertical sliding | Fade effect).
Enable Slideshow - if enabled, the module will automatically advance slider pages.
Slideshow Interval (sec.) - time between pages in seconds.
Max. number of results - total number of results that will be displayed.
Results per page - how many results will be displayed per slider page. If you enter the same number as for Max. number of results, then the module slider will be disabled and all results will be displayed at once.
Number of columns - choose how many results per row to show.
If you want to customize the theme file of the Favorite Users Module, this is its default location:
/com_jreviews/jreviews/views/themes/default/modules/favorite_users.thtml
Before you start customizing the theme files, make sure you read about JReviews Code Overrides functionality and create a custom theme.
You can create multiple custom copies of the Favorite Users Module theme file and enter their suffixes in the Theme Suffix parameter. Remember to clear JReviews File Registry when creating new theme files.
Totals Module is a very simple module that displays the total number of listings and reviews.
Example of the module layout:
Everywhere Extension - if you want to limit results to a specific extension, then enter it here (i.e. com_content, com_virtuemart, com_sobi2, etc.). Only ONE extension at a time!
JReviews Theme Suffix - this suffix will be applied to the module view file and is useful to create multiple instances of the module that have different outputs.
If you want to customize the theme file of the Totals Module, this is its default location:
/com_jreviews/jreviews/views/themes/default/modules/totals.thtml
Before you start customizing the theme files, make sure you read about JReviews Code Overrides functionality and create a custom theme.
You can create multiple custom copies of the Totals Module theme file and enter their suffixes in the Theme Suffix parameter. Remember to clear JReviews File Registry when creating new theme files.