Adding custom JReviews modules into listing detail pages

From JReviews Documentation
Revision as of 11:34, 15 March 2010 by Jreviews (Talk | contribs)

Jump to: navigation, search

Listings Module

Instead of including Listings Module into listing detail pages using loadposition plugin, you can output different versions of the module using the code below.

All the parameters are available like in the real Listings Module, and the same theme file is used:

  • \com_jreviews\jreviews\views\themes\{theme_name}\modules\listings.thtml


To use a different theme file for your custom module, add a suffix in the parameters: 'tmpl_suffix'=>'_custom'. Then you can create a copy of listings.thtml, rename it to listings_custom.thtml and customize the layout how you want. Always clear File Registry when creating new files.


The code of the custom module goes into the theme file of the listing detail page where you want the module to be displayed:

  • \com_jreviews\jreviews\views\themes\{theme_name}\listings\detail.thtml

You can use one of the tabs solutions to display custom module in a tab.


You can modify all module parameters to display exactly what you want.

A very powerful parameter is 'custom_where'.


Here are few examples:


Other listings written by the listing owner

<h2>Other listings by <?php echo $Community->screenName($listing);?></h2>
<?php
$moduleParams = array(
    'module_id'=>rand(1000,10000),
    'module'=>array(
	'slider_width'=>'600',
	'slider_height'=>'300',
	'listing_order'=>'latest', // rdate|rating|rrating|topratededitor|raviews|random|featuredrandom|rhits
	'extension'=>'com_content',
	'custom_where'=>"(Listing.created_by = {$listing['User']['user_id']})",
	'custom_order'=>'',
	'tmpl_suffix'=>'',
	'ajax_nav'=>'1',
	'nav_position'=>'bottom', // bottom|side
	'module_limit'=>'6',
	'columns'=>'2',
	'cat_auto'=>'0',
	'dir'=>'',
	'section'=>'',
	'category'=>'',
	'listing'=>'',
	'tn_show'=>'1',
	'tn_width'=>'50',
	'tn_mode'=>'crop', // crop|scale
	'filter_listing_period'=>'', // Filter: Listings submitted in past x days
	'filter_review_period'=>'', // Filter: Listings with reviews submitted in past x days
	'filter_review_count'=>'', // Filter: Listings with review count higher than
	'show_numbers'=>'0'
    )
);
echo $this->requestAction('module_listings/index/',$moduleParams);		
?>


This is how the module will be displayed:

CustomModule-OtherListings.png



Featured listings in this category

This module will show all featured listings from the same category as the listing being viewed.

If you want to show featured listings from all categories, just change the category parameter to:
'category'=>'',

<h2>Featured <?php echo $listing['Category']['title'];?></h2>
<?php
$moduleParams = array(
    'module_id'=>rand(1000,10000),
    'module'=>array(
	'slider_width'=>'600',
	'slider_height'=>'300',
	'listing_order'=>'featuredrandom', // rdate|rating|rrating|topratededitor|raviews|random|featuredrandom|rhits
	'extension'=>'com_content',
	'custom_where'=>'',
	'custom_order'=>'',
	'tmpl_suffix'=>'',
	'ajax_nav'=>'1',
	'nav_position'=>'bottom', // bottom|side
	'module_limit'=>'6',
	'columns'=>'2',
	'cat_auto'=>'0',
	'dir'=>'',
	'section'=>'',
	'category'=>$listing['Category']['cat_id'],
	'listing'=>'',
	'tn_show'=>'1',
	'tn_width'=>'50',
	'tn_mode'=>'crop', // crop|scale
	'filter_listing_period'=>'', // Filter: Listings submitted in past x days
	'filter_review_period'=>'', // Filter: Listings with reviews submitted in past x days
	'filter_review_count'=>'', // Filter: Listings with review count higher than
	'show_numbers'=>'0'
    )
);
echo $this->requestAction('module_listings/index/',$moduleParams);		
?>


This is how it will look like:

CustomModule-Featured.png



Reviews Module

You can also use the Reviews Module to create your custom modules and display them inside listing detail page.

Theme file of the Reviews Module is:

  • \com_jreviews\jreviews\views\themes\{theme_name}\modules\reviews.thtml


Reviews written about the listing owner in his JomSocial profile

If you use Jom Social and JReviews Everywhere Add-on to add reviews functionality to user profiles, you can use this custom module you can display reviews of the listing author inside listing detail pages.


<h2>Reviews of <?php echo $Community->screenName($listing);?></h2>
<?php
$moduleParams = array(
    'module_id'=>rand(1000,10000),
    'module'=>array(
        'slider_width'=>'600',
        'slider_height'=>'300',
        'reviews_order'=>'latest', // latest|helpful|random
        'reviews_type'=>'all', // all|user|editor
        'extension'=>'com_community_access',
        'custom_where'=>"(Review.pid = {$listing['User']['user_id']})",
        'custom_order'=>'',
        'tmpl_suffix'=>'',
        'ajax_nav'=>'1',
        'nav_position'=>'bottom', // bottom|side
        'module_limit'=>'6',
        'columns'=>'2',
        'cat_auto'=>'0',
        'dir'=>'',
        'section'=>'',
        'category'=>'',
        'listing'=>'',
        'tn_show'=>'1',
        'tn_width'=>'50',
        'tn_mode'=>'crop', // crop|scale
        'link_title'=>'{review_title}', // "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_comments'=>'1',
        'show_numbers'=>'0'
    )
);
echo $this->requestAction('module_reviews/index/',$moduleParams);
?>


This is how the module will be displayed:

CustomModule-Members.png


If you have any questions or comments about this functionality post on this forum topic