Magento RCI enviroment and setup requirements


  1. Before starting

It's highly suggested to turn on error logging before start.

To turn on the logging, you can navigate to System > Configuration > Developer > Log Settings and set the «Enabled» option to «Yes»
Don't forget to set full access permissions (777) to the following folder: /var/log, since that is the place where those log files are stored.

Also please prepare FTP connection in case something goes wrong and you are working with live shop.



2. Authentithication


Users must enter their Foxrate API username and passwords in module administration setup. All setup instructions are easily found in this module setup instructions.



3. Rich snippets


Rich snippets requires div tag with class .product-view:


<div class="product-view"></div>



4. Extends


This module extends various Magento blocks, so it requires them to be untouched or module should be customised, to meet new changes.


Current requirements are for blocks are :


<global> 

<blocks>

            <review>

                <rewrite>

                    <product_view>Foxrate_ReviewCoreIntegration_Block_Product_View</product_view>

                    <product_view_list>Foxrate_ReviewCoreIntegration_Block_Product_View_List</product_view_list>

                    <helper>Foxrate_ReviewCoreIntegration_Block_Helper</helper>

                </rewrite>

            </review>

            <rating>

                <rewrite>

                    <entity_detailed>Foxrate_ReviewCoreIntegration_Block_Review_Rating_Detailed</entity_detailed>

                </rewrite>

            </rating>

            <catalog>

                <rewrite>

                    <product_list>Foxrate_ReviewCoreIntegration_Block_Product_List</product_list>

                </rewrite>

            </catalog>

            <page>

                <rewrite>

                    <html>Foxrate_ReviewCoreIntegration_Page_Block_Html</html>

                </rewrite>

            </page>

        </blocks>

 

    ...

</<global>



So these blocks are required with namespace /global/blocks: review, rating, catalog, page


review_product_list is also extended with:


<review_product_list>

        <action method="setTemplate" block="product.info.product_additional_data">

            <tpl>foxrate/review/product/view/foxrate_list.phtml</tpl>

        </action>

        <reference name="product.info.product_additional_data">

            <block type="review/product_view" name="foxrate_summary" template="foxrate/foxrate_general_details.phtml"/>

            <block type="review/product_view" name="foxrate_review_list" template="foxrate/foxrate_review_list.phtml"/>

        </reference>

    </review_product_list>

 

5. Steps and actions:


1. If user has build his template on default Magento template, in many cases everything should work. If not, go to 2. If user has build custom template / is using bought template, he should know which parts are changed and maybe he can correct . In this case changes from their side they cannot do much, because drastic changes will break their shop, so they goes to 2.


2. If user has touched something in his blocks/templates, at first he may inform us with:
- what template they are using
- what changes are done
- to provide as many resources as possible: files, ftp, teamviewer connection
Maybe we will find a sollution, that will help for other users.