Magento – load custom review attribute

event-observermagento-1.9modelreview

I'm using magento 1.9.2.4 version.
I tried to add custom field(file) in product review page. I have added new attribute to review_detail table using

$installer->run("ALTER TABLE {$this->getTable('review_detail')} 
    ADD COLUMN(customfield' varchar(255) NULL);

Now added the field in review_detail table. Now i'm trying to add/save the data with customfield using my custom module review_save_before event by calling myFunction.
When printing the model, it does not added my custom field.

MyFunction code is here

public function myFunction(Varien_Event_Observer $observer)
{
    $object = $observer->getEvent()->getObject();
    $data = $object->getData();
    $review = Mage::getModel('review/review')->getCollection()->getData();
    echo "<pre>";
    print_r($data);
    exit;
}

How to assign and save data for my customfield using the model.

Updates:
Config.xml

<models>
    <customreview>
        <class>Mycompany_Customreview_Model</class>
        <resourceModel>customreview_mysql4</resourceModel>
    </customreview>
    <customreview_mysql4>
        <class>Mycompany_Customreview_Model_Mysql4</class>
        <entities>
            <customreview><table>review_detail</table></customreview>
        </entities>
        <rewrite>
            <review>Mycompany_Customreview_Model_Resource_Review</review>
        </rewrite>
    </customreview_mysql4>
</models>
<resources>
    <customreview_setup>
        <setup>
            <module>Mycompany_Customreview</module>
            <class>Mage_Eav_Model_Entity_Setup</class>
        </setup>
        <connection>
            <use>core_setup</use>
        </connection>
    </customreview_setup>
    <customreview_write>
        <connection>
            <use>core_write</use>
        </connection>
    </customreview_write>
    <customreview_read>
        <connection>
            <use>core_read</use>
        </connection>
    </customreview_read>
</resources>

<review_save_after>
    <observers>
        <add_custom_field_to_the_review>
            <type>singleton</type>
            <class>customreview/observer</class>
            <method>myFunction</method>
        </add_custom_field_to_the_review>
    </observers>
</review_save_after>

In installer script:

$installer->getConnection()
    ->addColumn($installer->getTable('review/review_detail'),'customfield', array(
        'type'      => Varien_Db_Ddl_Table::TYPE_TEXT,
        'nullable'  => false,
        'length'    => 255,
        'comment'   => 'Custom Field'
    ));

In my phtml file:

<li>
    <label for="customfield" class="required"><em>*</em><?php echo $this->__('Custom Field') ?></label>
    <div class="input-box">
        <textarea name="customfield" id="customfield" cols="5" rows="3" class="required-entry"><?php echo $this->escapeHtml($data->getCustomfield()) ?></textarea>
    </div>
</li>

My observer:

public function myFunction($observer)
{
    $object = $observer->getEvent()->getObject();
    if (!$object->getCustomfield()) {
        echo "nop";exit;
        return $this;
    }

    try {
        /** @var Varien_Db_Adapter_Interface $connection */
        $adapter = Mage::getSingleton('core/resource')->getConnection('core_write');
        $reviewDetailTable = $adapter->getTableName('review_detail');
        $select = $adapter->select()
            ->from($reviewDetailTable, 'detail_id')
            ->where('review_id = :review_id');
        $detailId = $adapter->fetchOne($select, array(':review_id' => $object->getId()));

        if ($detailId) {
            $detail = array(
                'customfield' => $object->getCustomfield()
            );
            $condition = array("detail_id = ?" => $detailId);
            $adapter->update($reviewDetailTable, $detail, $condition);
        }
    } catch (Exception $e) {
        Mage::logException($e);
    }

    return $this;
}

Best Answer

Data is saved to the table review/review_detail with different method. There are 3 fields in the resource model:

title
detail
nickname

They are saved manually to this table. Other data is ignored whether it present in the review model or not. Here is a part of code responsible for that:

/**
 * Perform actions after object save
 *
 * @param Varien_Object $object
 * @return Mage_Review_Model_Resource_Review
 */
protected function _afterSave(Mage_Core_Model_Abstract $object)
{
    $adapter = $this->_getWriteAdapter();
    /**
     * save detail
     */
    $detail = array(
        'title' => $object->getTitle(),
        'detail' => $object->getDetail(),
        'nickname' => $object->getNickname(),
    );
    $select = $adapter->select()
        ->from($this->_reviewDetailTable, 'detail_id')
        ->where('review_id = :review_id');
    $detailId = $adapter->fetchOne($select, array(':review_id' => $object->getId()));

    if ($detailId) {
        $condition = array("detail_id = ?" => $detailId);
        $adapter->update($this->_reviewDetailTable, $detail, $condition);
    } else {
        $detail['store_id'] = $object->getStoreId();
        $detail['customer_id'] = $object->getCustomerId();
        $detail['review_id'] = $object->getId();
        $adapter->insert($this->_reviewDetailTable, $detail);
    }

You have several options:

You can save your data in the table review/review and not in the table review/review_detail.
You can write an observer to add necessary data after saving all the review objects (save_after) and save again.

I suppose, that the first option is better. All you need to realize it is to add your field to the table review/review. After that all data will be saved automatically without an observer.

If you choose the second option, you should rewrite your observer in the following way:

Use the event review_save_after in the config.xml file:

<events>
    <review_save_after>
        <observers>
            <add_custom_field_to_the_review>
                <type>singleton</type>
                <class>test/observer</class>
                <method>myFunction</method>
            </add_custom_field_to_the_review>
        </observers>
    </review_save_after>

Do the following changes in your method:

public function myFunction($observer)
{
    $object = $observer->getEvent()->getObject();
    if (!$object->getCustomfield()) {
        return $this;
    }

    try {
        /** @var Varien_Db_Adapter_Interface $connection */
        $adapter = Mage::getSingleton('core/resource')->getConnection('core_write');
        $reviewDetailTable = $adapter->getTableName('review_detail');
        $select = $adapter->select()
            ->from($reviewDetailTable, 'detail_id')
            ->where('review_id = :review_id');
        $detailId = $adapter->fetchOne($select, array(':review_id' => $object->getId()));

        if ($detailId) {
            $detail = array(
                'customfield' => $object->getCustomfield()
            );
            $condition = array("detail_id = ?" => $detailId);
            $adapter->update($reviewDetailTable, $detail, $condition);
        }
    } catch (Exception $e) {
        Mage::logException($e);
    }

    return $this;
}

This allows to successfully save data to the table review_details.

We checked this by adding the input form to the products review.

<li>
    <label for="customfield" class="required"><em>*</em><?php echo $this->__('Custom Field') ?></label>
    <div class="input-box">
        <textarea name="customfield" id="customfield" cols="5" rows="3" class="required-entry"><?php echo $this->escapeHtml($data->getCustomfield()) ?></textarea>
    </div>
</li>

Additionally, we recommend you to update your installation script:

<?php
/* @var $installer Mage_Core_Model_Resource_Setup */
$installer = $this;
$installer->startSetup();

$installer->getConnection()
    ->addColumn($installer->getTable('review/review_detail'),'customfield', array(
        'type'      => Varien_Db_Ddl_Table::TYPE_TEXT,
        'nullable'  => false,
        'length'    => 255,
        'comment'   => 'Custom Field'
    ));

$installer->endSetup();

1. Add one attribute for each input field to the order

To add the order attribute, create a setup script with the following contents, after adding a setup resource and a version number to your module:

/* @var $installer Mage_Sales_Model_Resource_Setup */
$installer = Mage::getResourceModel('sales/setup', 'sales_setup');

$installer->startSetup();

$installer->addAttribute('order', 'my_field', array(
    'label' => 'My Field',
    'type' => 'varchar',
    'input' => 'text',
    'required' => false,
));

$installer->endSetup();

2. Display the input field(s) on the review step

To display the input field in the review step, first add a layout XML file to your module:

<frontend>
    <layout>
        <updates>
            <namespace_reviewfieldield>
                <file>namespace/reviewfield.xml</file>
            </namespace_reviewfieldield>
        </updates>
    </layout>
</frontend>

Then create the layout XML file base/default/layout/namespace/reviewfield.xml with the following contents:

<?xml version="1.0"?>
<layout>
    <checkout_onepage_review>
        <reference name="checkout.onepage.review.info.items.after">
            <block type="core/template" name="namespace.reviewField" template="namespace/reviewfield/form.phtml"/>
        </reference>
    </checkout_onepage_review>
</layout>

Finally you create the template base/default/template/namespace/reviewfield/form.phtml

<div class="checkout-agreements">
    <input type="text" name="namespace_reviewfield" id="namespace_reviewfield"/>
    <label for="namespace_reviewfield">Please specify Foo</label>
</div>

3. Make sure the input fields are submitted when the order is saved

Now the field will be displayed after the totals on the review step. But because the field is not inside of any form, you need to take care it is submitted when the order is saved.
Add the following JavaScript to your form.phtml template.

<script type="text/javascript">
    // Add our field to the data submitted by Review.save()
    Review.prototype.save = Review.prototype.save.wrap(function(orig) {
        var form = this.agreementsForm ? this.agreementsForm : payment.form;
        if (form) {
            var myfield = $('namespace_reviewfield');
            form.insert(myfield);
        }
        orig();
    });
</script>

4. Set the submitted values on the order

Now the field value will be sent to Magento when the order is submitted. Only so far, nothing else happens with it. You have to set the submitted value on the order. A good way to do that is using an event observer for the checkout_type_onepage_save_order event.

<frontend>
    <events>
        <checkout_type_onepage_save_order>
            <observers>
                <namespace_reviewfield>
                    <type>model</type>
                    <class>namespace_reviewfield/observer</class>
                    <method>checkoutTypeOnepageSaveOrder</method>
                </namespace_reviewfield>
            </observers>
        </checkout_type_onepage_save_order>
    </events>
</frontend>

The observer class itself is very simple:

class NameSpace_ReviewField_Model_Observer
{
    public function checkoutTypeOnepageSaveOrder(Varien_Event_Observer $observer)
    {
        /** @var Mage_Sales_Model_Order $order */
        $param = Mage::app()->getRequest()->getParam('namespace_reviewfield', '');
        $observer->getOrder()->setMyField((string) $param);
    }
}

And that takes care of the frontend side of things.

5. Add a new tab to the order info page in the backend

Unfortunately, there is no "nice" way to add content to the general order info page. It's much more compatible to add a new tab with the new content you want to display. To do that, you first need to add an adminhtml layout XML file:

<adminhtml>
    <layout>
        <updates>
            <namespace_reviewfield>
                <file>namespace/reviewfield.xml</file>
            </namespace_reviewfield>
        </updates>
    </layout>
</adminhtml>

The new tab itself is then added in the layout XML declaration. There are several ways this can be done, but I suggest you use the probably most straightforward way by adding the following code to the file adminhtml/default/layout/namespace/reviewfield.xml

<?xml version="1.0"?>
<layout>
    <adminhtml_sales_order_view>
        <reference name="sales_order_tabs">
            <action method="addTab">
                <name>namespace_reviewfield</name>
                <block>namespace_reviewfield/adminhtml_order_tab_reviewfield</block>
            </action>
        </reference>
    </adminhtml_sales_order_view>
</layout>

6. Display the field values

Now you only need to create the block that you specified in the layout XML and a matching template. The block class has to implement Mage_Adminhtml_Block_Widget_Tab_Interface, otherwise a "Wrong Tab Configuration" exception will be thrown.
Here is a simple example:

class NameSpace_ReviewField_Block_Adminhtml_Order_Tab_Reviewfield
    extends Mage_Adminhtml_Block_Widget
    implements Mage_Adminhtml_Block_Widget_Tab_Interface
{
    protected function _prepareLayout()
    {
        $this->setTemplate('namespace/order/tab/reviewfield.phtml');
    }

    public function getOrder()
    {
        return Mage::registry('current_order');
    }

    public function getTabLabel()
    {
        return $this->__('Review Field');
    }

    public function getTabTitle()
    {
        return $this->getTabLabel();
    }

    public function canShowTab()
    {
        return true;
    }

    public function isHidden()
    {
        return false;
    }
}

The final missing thing is the template adminhtml/default/template/namespace/order/tab/reviewfield.phtml. Just make sure you properly escape any user input to avoid XSS holes.

<?php /** @var NameSpace_ReviewField_Block_Adminhtml_Order_Tab_Reviewfield $this */ ?>
<div>
    <?php echo $this->__('The customer entered: %s', $this->escapeHtml($this->getOrder()->getMyField())) ?>
</div>

Hope that helps you along the way to implement the functionality you require.

Magento – Load review form on external page

If this exact url structure is an requirement, you could solve this by implementing an own router.

the xml needed is something like

<config>
    <default>
    <web>
        <routers>
            <my_review>
                <area>frontend</area>
                <class>My_Review_Controller_Review_Router</class>
            </my_review>
        </routers>
    </web>
    </default>
</config>

this class needs to extend from Mage_Core_Controller_Varien_Router_Standard and overwrite the match method.

You can then parse the url, if it ends with -review-form you can extract the product part, and see if you have a product with this url-key or look in the rewrite table for it, not sure what is more stable. If it does not match, exit the function with a return. If it matches, I would suggest to an internal redirect to a route of your controller which is implemented as the others suggested.

The performance impact is nearly nothing, as you dont cause a database query for the initial -review-form test, and trough the internal redirect towards a normal controller you keep the additional complexity low.