Product Release Information

Product:	Enhanced Product Rating and Reviews Display Module for CRELoaded 6.2-6.4
Release Number:	1.0.1
Release Date:	Aug 2, 2009
Customer Support:	For more information or support, please visit our website or contact us from the online form

Introduction

This document describes how to install and get started with Enhanced Product Rating and Reviews Display Module. The Enhanced Product Rating and Reviews Display Module shows the reviews for a product on its description page.

Features of the Enhanced Product Rating and Reviews Display Module:

• Shows the reviews for a product on its description page (if any) in a nice shaded box.
• Set the number of reviews you'd like shown by changing the number in the Admin » Configuration » Maximum Values
• Show or hide the rating icon on product page by changing the value in the Admin » Configuration » My Store
• Show or hide the rating icon on category page by changing the value in the Admin » Configuration » My Store
• Fully integrated with CRELoaded 6.2-6.4, easy to install, with details in the installation guide.

Minimal System Requirements

System requirements are described in the release notes.

Installation

What other software must be installed first?

Before you can install this product, you must obtain access to a web server with the following:

• PHP 4.x with :
• GD Library
• mCrypt
• Register Globals set to On via httpd.conf, php.ini or .htaccess
• The Apache Webserver
• MySQL database
• The Linux / Unix Operating System
• CRE Loaded 6.2

How do I install CRE Loaded : Enhanced Product Rating and Reviews Display Module?

Please follow these steps:

1. Upload the files to your catalog directory on the webserver.


2. Open includes/functions/general.php file, before
   ?>
   add
   function tep_get_product_average_rating($products_id) { $reviews_query_average = tep_db_query("select (avg(reviews_rating)) as average_rating from " . TABLE_REVIEWS . " where products_id = '" . (int)$products_id . "'"); $reviews_average = tep_db_fetch_array($reviews_query_average); return number_format($reviews_average['average_rating'], 0); }


3. Open templates/content/product_info.tpl.php file, change
   echo '<a href="' . tep_href_link(FILENAME_PRODUCT_REVIEWS, tep_get_all_get_params() . $params) . '">' . tep_template_image_button('button_reviews.gif', IMAGE_BUTTON_REVIEWS,'align="middle"') . '</a>';
   to
   if (!defined('MAX_REVIEWS_IN_PRODUCT_INFO') || MAX_REVIEWS_IN_PRODUCT_INFO <= 0) {echo '<a href="' . tep_href_link(FILENAME_PRODUCT_REVIEWS, tep_get_all_get_params() . $params) . '">' . tep_template_image_button('button_reviews.gif', IMAGE_BUTTON_REVIEWS,'align="middle"') . '</a>';}
   
   after
   if (B2B_PRICE_BREAK == 'true') { include(DIR_WS_MODULES . FILENAME_PRODUCT_QUANTITY_TABLE); }
   add
   include(DIR_WS_MODULES . 'review.php');


4. Open includes/modules/product_listing_col.php file, after
   $product_contents[] = $lc_text; }
   add
   if (defined('SHOW_RATING_ICONS_ON_CATEGORY') && SHOW_RATING_ICONS_ON_CATEGORY == 'true') { $reviews_query = tep_db_query("select count(*) as count from " . TABLE_REVIEWS . " where products_id = '" . $listing[$x]['products_id'] . "'"); $reviews = tep_db_fetch_array($reviews_query); if ($reviews['count'] > 0) { $reveiws_rating = tep_get_product_average_rating($listing[$x]['products_id']); $product_contents[] = tep_image(DIR_WS_IMAGES . 'stars_' . $reveiws_rating . '.gif', '', 60, 12, 'align=absmiddle'); } else { $product_contents[] = ' '; } }


5. Run SQL statement in phpMyAdmin:
   INSERT INTO configuration (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added) VALUES ('Number of Reviews in Product Description', 'MAX_REVIEWS_IN_PRODUCT_INFO', '3', 'Number of reviews to display<br>on product information page?<br><br>(set to 0 to disable)', '3', '25', now()); INSERT INTO configuration (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added, use_function, set_function) values ('Show Rating icons on product display', 'SHOW_RATING_ICONS_ON_PRODUCT', 'true', 'enable it to show the rating icon on product page.', '1', '26', now(), '','tep_cfg_select_option(array(''true'', ''false''),'); INSERT INTO configuration (configuration_title, configuration_key, configuration_value, configuration_description, configuration_group_id, sort_order, date_added, use_function, set_function) values ('Show Rating icons on category display', 'SHOW_RATING_ICONS_ON_CATEGORY', 'true', 'enable it to show the rating icon on category page.', '1', '27', now(), '','tep_cfg_select_option(array(''true'', ''false''),');

How can I uninstall CRE Loaded : Enhanced Product Rating and Reviews Display Module?

    1. Delete all files that you added

    2. Change all modified files back.

    3. Run SQL statement in phpMyAdmin:
        DELETE FROM configuration WHERE configuration_key IN ('MAX_REVIEWS_IN_PRODUCT_INFO', 'SHOW_RATING_ICONS_ON_PRODUCT', 'SHOW_RATING_ICONS_ON_CATEGORY') LIMIT 3;

What if I encounter problems?

    Please see the troubleshooting section in the FAQ.