Detailed Product Review extension was created to give you more information about customers' opinion and to express for your customers their thoughts and feelings about your products. As specialists discovered, one of the most important factors that influence customers decision is the opinion of others customers. This extension will help to make your store more interactive and attractive for people. The flexible set of settings allows you to create different ratings that will reveal the main theme of your site.

Statistics, analysis? What products are top-rated or less-rated? Which reviews were written last month? Need to know top-rated products from the particular category? Any information is available via Detailed Product Review! Do not spend money for nothing, you can plan your business to get more profit.

Create the review that will show the individuality of your site. Clothing, computers, media? Whatever your products are - you can customize reviews so that they will never look like on other sites. Simple Javascript review form doesn't take place on the page and its design will be surely liked by customers.

Are you afraid of spam? Need moderation, but have hundreds of products? Guests are disallowed to write reviews by default, pre-moderation of reviews is turned on so nobody will have an ability to write spam instead of a real review. Anyway, these features can be turned off - only you can decide who will have an opportunity to write reviews to your products.

• 1. Create a backup.
• 2. Disable the Magento Compiler (if it is enabled).
• 3. Disable all types of cache used (Magento/FPC/Varnish, etc).
• 4. Choose package file in “Direct package file upload” section.
• 5. Click on the Upload button to start the installation.
• 6. Re-login into Magento Admin Panel to reload module permissions for your account.
• 7. Re-enable the Magento Compiler (if it was disabled on the step #2).
• 8. Re-enable Cache (if it was disabled on the step #3).
• 9. Enter License Key.

Note that the extension package has included two obfuscated files:

• app / code / local / MageWorkshop / DetailedReview / Model / Observer.php
• app / code / local / MageWorkshop / DetailedReview / Helper / Data.php

That files containing part of the license generation algorithm.

If there is antivirus software installed on the server or there is one which is providing by hosting provider as part of the hosting service then there is possibility false-positive antivirus activation. To prevent it this files should be added to the ignore list. If above files have been deleted please use ones from the module package to restore them (unpack and copy them to the corresponding paths).

• 1. Create a backup.
• 2. Disable the Magento Compiler (if it enabled).
• 3. Uploading archive to the Magento web root.
• 4. Extract files tar -xf archive.tgz -C ./ (instead of “archive.tgz” you have to use the archive of DetailedReview module).
• 5. Refresh the Magento cache.
• 6. Re-login into Magento Admin Panel.
• 7. Re-enable the Magento Compiler (if it was disabled on the step #2).

To configure Detailed Product Review extension you should login into Magento system and navigate to System → Configuration → Detailed Review configuration tab.

To see Reviews Statistics go to Catalog → Reviews and Ratings → Customer Reviews → Reviews Statistics.

Image reviews statistics for Top Most Reviewed Products, Top Most Liked Products, Top Most Disliked Products, Top Most Active Customers. There is an ability to navigate and to edit item directly from the grid.

To add new Pros go to the Catalog → Reviews and Ratings → Customer Reviews → Pros and click Add Pros button.

• 1. In the Name field enter the title which will be shown in the Pros Management page and on Product page.
• 2. In the Status field select Enabled.
• 3. In Wrote By select Administrator.
• 4. In the Store View select the websites where Pros will be displayed.
• 5. The Sort Order field allows specifying the sequence of properties displaying.

Click the Save Pros button.

Pros and Cons which are added manually, will be included in list and appear in Admin area so Admin will be able to add them as standard ones. To configure Pros and Cons go to the Catalog → Reviews and Ratings → Customer Reviews → User-defined Pros and Cons. There will be a grid with all pros and cons which were predefined previously by Admin as far as manually entered by review author’s.

If you click on Pros or Cons you will be able to edit it. There are options which allowing you to change Name, Status (if “Enabled” is chosen this item appear in Pros or Cons section on front-end), Wrote By, Store View and Sort Order.

There is an ability to ban author of a review so he will not be able to write further reviews. You could check review, select "Prevent this Author from Posting Reviews" option and choose for how long Author's IP should be banned. In case, the author was logged into the system when he was writing the review then the customer will be banned from writing the review. Otherwise, IP will be banned. You should be aware that several devices could use same external IP which might lead to the false-positive bans.

There are two ways for ban: go to Catalog → Reviews and Ratings → Customer Reviews → All Reviews or go to Customers → Manage Customers.

To unblock banned author of review do the same steps, but select “Lift Ban” option from the drop-down.

There is an ability to configure the available review fields and different pros and cons depending on different categories. In this way, the store owner will gain an ability to have the different review options for different categories so, for example, Body Type will not appear in “Electronics” section. To utilize this feature go to Catalog → Manage Categories → {Category_name} and switch to the Detailed Product Review Settings tab. Find Available Review Fields, Pros and Cons, select necessary attributes and save changes. If you mark the checkbox for “Use Parent Category Settings for Review Fields” this attribute will inherit the value from the parent. The available review fields section becomes not editable. The same for "Use Parent Category Settings for Pros and Cons Fields" option.

Registered customer has the ability to look through own reviews from the My Account section. Login to the shop and go to the My Account → My Reviews. There will be a statistical data about the review and all own reviews.

There are two main ways to translate Detailed Product Review extension.

In the first case, you could turn on Translate Inline functionality. Go to Admin area System → Configuration → Developer → Translate Inline section and set to Yes the Enabled for Frontend. Inline translate does not always work properly<,> though. So you might want to use second way.

In second case if some labels couldn't be translated using Translate Inline feature, go to /app/locale/es_ES/ (if there is no such folder, navigate to Admin area System → Configuration → Design → Themes → Translations and check the locale folder name after this create new folder under /app/locale/{LOCALE_FOLDER_NAME}/) then copy to this folder the MageWorkshop_DetailedReview.csv file and edit it. There will be a list of items which are already added to CSV file. To translate a particular item edit label in the second column and save changes. If wording what you are looking for<,> is not there, then write it manually in the first column in quotes (spelling should match exactly) and in the second column write translated value using a comma to separate them.

When translation is finished, clean Magento cache and reload page to see changes.

For example: “Write a Review”, “Оставить отзыв”.

Detailed Product Review extension supports the review placeholder. You could use this feature at any point in any place on the product page. Just insert the next tag < div class="reviews-placeholder"> </div> in that place where you want to see the review section.

Basically for this you need to edit file: app/design/frontend/<THEME_PATH>/template/catalog/product/view.phtml.

To use Detailed Product Review extension in your custom theme, you need to do the following steps:

1) copy files from app/design/frontend/base/default/template/detailedreview to the app/design/frontend/<DEFAULT_THEME_PATH>/template/detailedreview directory. This step is required if some of the review templates have to be modified;

2) copy files from skin/frontend/base/default/css/detailedreview to the skin/frontend/<DEFAULT_THEME_PATH>/css/detailedreview directory and skin/frontend/base/default/images/detailedreview to the skin/frontend/<DEFAULT_THEME_PATH>/images/detailedreview directory. This step is required if you need to change CSS styles of the review;

3) if you have multiple stores that require different styles then you have to copy all this files to the folder with the store theme files, not the default one.

Paths for single store usually look like this:

• - app/design/frontend/default/default/...
• - skin/frontend/default/default/...

If you have multiple stores then probable path will differ:

• - app/design/frontend/default/<STORE_THEME_NAME>/...
• - skin/frontend/default/<STORE_THEME_NAME>/…

To use responsive Detailed Product Review version (for Magento CE 1.9 and higher) you need to copy files from skin/frontend/rwd/default/css/detailedreview to the skin/frontend/rwd/<DEFAULT_THEME_PATH>/css/detailedreview directory, skin/frontend/rwd/default/images/detailedreview to the skin/frontend/rwd/<DEFAULT_THEME_PATH>/images/detailedreview directory and skin/frontend/rwd/default/scss/detailedreview to the skin/frontend/rwd/<DEFAULT_THEME_PATH>/scss/detailedreview directory.

For now our extension uses such Javascript libraries:

• 1) jQuery 1.8.0;
• 2) jQuery.ui 1.8.23 with such components:
• • a) UI Core: All;
  • b) Interactions: Draggable, Resizable;
  • c) Widgets: Button, Dialog, Slider;
  • d) Effects: Effects Core, Blind Effect, Fade Effect.
• 3) jQuery.easing 1.3;
• 4) jQuery.spy;
• 5) jQuery.Magnific Popup 0.9.9;
• 6) jQuery Placeholder 2.0.7.

jQuery in our extension is defined as DRjQuery global object to prevent conflicts with Magento extensions that also use jQuery libraries. If you use the same libraries you will have to assign your jQuery to it or replace DRjQuery string with jQuery in app/design/frontend/base/default/template/ folder. We recommend to attach required versions of jQuery and plugins by yourself and to use them instead of this file (otherwise most probably you will have 2 jQuery objects in memory and general plugins will be duplicated).

If you do not need to load these libraries in one file or you've already got this libraries loaded on your website, you can disable loading DRjQuery by changing "Enable jQuery and Other Plugins" option in Detailed Review settings or you can comment/delete ~7th line in app/design/frontend/base/default/layout/detailedreview.xml file (which includes this file to the page content) and replace libraries with your versions. Note that this may cause errors in Javascript if not all needed libraries are included or they have incompatible versions.

To change "Body Type" you need to go to the file app/code/local/MageWorkshop/DetailedReview/Model/Review/BodyType.php, change/add/remove options in getOptionArray() method and remove/edit/add constant of this class. Constants and values should be unique. Then go to skin/frontend/base/default/images/detailedreview/bodytypes/ and add here file(s) using such naming convention "[option_name]-shape.jpg"

Try not to change constants' value if you need to edit type, because these values are stored in the database.

If you need to remove some type, you need to execute this SQL script as well (this will delete all information about body type from all reviews):

UPDATE `review_detail` SET `body_type`= NULL WHERE `body_type` = [VALUE]. Here [VALUE] is the constant that represents body type. For example for BODY_TYPE_TRIANGLE [VALUE] is 1.

To manage Reviews Reminders, you need to go to Catalog → Reviews and Ratings → Customer Reviews → Reviews Reminder. You can view, edit, delete reminders and change status for selected reminders:

On Hold - Reminder Email should not be sent automatically, only manually;

Pending - Reminder Email should be sent automatically;

Sent - when you choose this status, Reminder Email will be sent immediately.

Create Reminders for Old Orders button allows to generate Reminders for orders, which were submitted before Detailed Product Review extension installation.

To customize Reminder email template, you need to go to System → Transactional Emails, press Add New Template and choose Remind Review template. When new email template was created, go to Detailed Review Configuration page and change Email Template configuration in Review Reminders section.

How to display rating stars?

Login to the admin area, go to Catalog -> Review and Rating -> Manage and Rating, select the value for rating (Price, Quality, Value), click on it, make visible for the store and save changes.

I’ve installed the extension, but can’t find it in the admin area. What should I do?

You need re-login into Admin Panel. If this won’t help then Flush Magento Cache and launch Reindex.

I need to uninstall the extension. Do I need to do this using Magento Downloader?

No, you need to login to Admin Panel, then proceed to System -> Configuration -> Detailed Product Review tab and go to the Uninstall section. Then click “Uninstall” button and confirm that you want to delete extension.

I’ve uninstalled the extension using Magento downloader despite the red label near uninstall button and now frontend and backend are broken. What should I do?

You should have access to database (for example via phpMyAdmin). Select your database, select eav_attribute table, search by attribute_code for these fields: review_fields_available, use_parent_review_settings, popularity_by_sells, popularity_by_reviews, popularity_by_rating. Remove them.

Also, you need to delete these tables:

• review_helpful
• author_ips
• review_proscons

And delete such columns from review_detail:

• remote_addr
• sizing
• body_type
• location
• age
• height
• good_detail
• no_good_detail
• response
• image
• video
• pros
• cons
• recommend_to

Here is the list of MySQL commands to revert all changes in DB:

• 1) DELETE FROM eav_attribute WHERE attribute_code IN ('review_fields_available', 'use_parent_review_settings', 'popularity_by_sells', 'popularity_by_reviews', 'popularity_by_rating')
• 2) DROP TABLE IF EXISTS review_helpful, author_ips, review_proscons
• 3) ALTER TABLE review_detail DROP COLUMN remote_addr, DROP COLUMN sizing, DROP COLUMN body_type, DROP COLUMN location, DROP COLUMN age, DROP COLUMN height, DROP COLUMN good_detail, DROP COLUMN no_good_detail, DROP COLUMN response, DROP COLUMN image, DROP COLUMN video, DROP COLUMN pros, DROP COLUMN cons, DROP COLUMN recommend_to

Note that the last command (#3) can depend on your Detailed Product Review module version (not all columns are present in your database)

Is there an ability to change rating stars?

Yes, it is. You need to login to Admin Panel and go to System -> Configuration -> Detailed Review tab and expand Rating Images section. Then click on “Choose file” button for appropriate fields.

How can I translate extension?

The main way is to turn on Translate Inline functionality. Go to Admin Panel → System → Configuration → Developer → Translate Inline section and set Enabled for Frontend to Yes. Inline translate does not always work properly. So you might want to use the other way.

In second case if some labels are not translated using the Translate Inline feature, go to /app/locale/{LOCALE_FOLDER_NAME}/ (if there is no such folder, navigate to Admin area System → Configuration → Design → Themes → Translations and check locale folder name. After this create new folder under /app/locale/{LOCALE_FOLDER_NAME}/) and copy MageWorkshop_DetailedReview.csv file to this folder and edit it. There will be a list of items which are already added to CSV file. To translate particular item, you should edit label in the second column and save changes. If wording what you are looking for is not there, then you should write it manually in the first column in quotes (spelling should match exactly) and in the second column write translated value using a comma to separate them.

When translation is finished, clean Magento cache and reload the page to see changes.

I have a problem in “Recent Reviews” block. It shows Magento default logo instead of the product thumbnail image. How can it be fixed?

This is actual only for early extension versions. So just update the extension. If there is no ability to do so for some reasons go to Admin Panel → System → Configuration → Catalog Tab, expand Frontend section and disable “Use Flat Catalog Category” and “Use Flat Catalog Categories" options.

How do I change the location of the review in the product view page?

You can put div with class "reviews-placeholder" on the page and Detailed Product Review will be displayed inside.

I got an error after installation, on product Magento crashes with SQLSTATE[42S22]: Column not found: 1054 Unknown column 'main_table.use_parent_review_settings' in field list, how I can fix this?

You need to login to Admin Panel, then Flush Magento Cache and launch Reindex.

After installation of Detailed Product Review extension, old reviews will remain on my website?

All previous reviews will be displayed after installation of our extension.

Instruction for Review fields customization.

For a successful and safe development, it is desirable to deploy the site to the developer's environment.

Follow steps below:

• 1) Put the website in the maintenance mode.
• 2) Create system and database backups.
• 3) Add one more sub-version after the patch number of the current module's version. For that open the file app/code/local/MageWorkshop/DetailedReview/etc/config.xml find node <version>2.1.1</version> for example and add the sub-version. In this case it will be "2.1.1.1"
• 4) Prepare install script with new field. You can see examples in directory app/code/local/MageWorkshop/DetailedReview/sql/detailedreview_setup In this example should create new file(script) with name "upgrade-2.1.1-2.1.1.1.php"
• 5) Add new field(from step 4)) in DetailedReview Form. You can find form in app/design/frontend/base/default/template/detailedreview/review/form.phtml
• 6) Validation rule example you can find in app/code/local/MageWorkshop/DetailedReview/Helper/Validate.php. You may add custom validation for the new field or use ready-made kits.
• 7) Add a field to Admin Panel into Review Forms. New Review Form exists in app/code/local/MageWorkshop/DetailedReview/Block/Adminhtml/Review/Add/Form.php. Edit existing Review Form in app/code/local/MageWorkshop/DetailedReview/Block/Adminhtml/Review/Edit/Form.php.
• 8) Add field to collection. For that go to app/code/local/MageWorkshop/DetailedReview/Model/Mysql4/Review/Collection.php, find _initSelect() function and add new field.
• 9) If it is necessary, add a field to Review list. Review list is located in app/design/frontend/base/default/template/detailedreview/review/product/view/list.phtml
• 10) Add new field into function "_afterSave()". Find array "$detail" and add in it the new field similar to the existing fields.
• 11) Clear all caches.
• 12) Move the Website from the maintenance mode and reload frontend page.

If you found any bugs, you think some functionality is missing or does not work properly or you having issues in the extension setup or customization please contact us at [email protected] We are always happy to help