Magento – Magento2 Add custom field to review form

magento-2.1magento-2.1.3magento2product-reviewreview

I am trying to add a custom field in review form in the product page. Below is my code:

InstallData.php

namespace Namespace\Mymodule\Setup;

use Magento\Framework\Setup\InstallDataInterface;
use Magento\Framework\Setup\ModuleContextInterface;
use Magento\Framework\Setup\ModuleDataSetupInterface;
Class InstallData implements InstallDataInterface
{
     public function install(ModuleDataSetupInterface $setup, ModuleContextInterface $context)
     {
        $installer = $setup;
        $setup->startSetup();
       // $eavSetup = $this->eavSetupFactory->create(['setup' => $setup]);

        $reviewTable = 'review_detail';

        $setup->getConnection()
            ->addColumn(
                $setup->getTable($reviewTable),
            'refer_field',
            [
                'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
                'label' => 'Would you recommend this product to a friend',
                'comment' =>'Would you recommend this product to a friend',
                'input' => 'select',
                'required' => false,
                'visible' => true,
                'user_defined' => true,
                'sort_order' => 101,
                'position' => 101,
                'system' => 0,
                'option' =>
                    array (
                        'values' =>
                            array (
                                0 => 'Yes',
                                1 => 'No',
                            ),
                    ),
                        ]
        );
         $setup->endSetup();
     }
}

app/code/Namespace/Mymodule/view/frontend

<?xml version="1.0"?>
<!--
/**
 * Copyright © 2016 Magento. All rights reserved.
 * See COPYING.txt for license details.
 */
-->
<page xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:View/Layout/etc/page_configuration.xsd">
    <update handle="review_product_form_component"/>
    <body>
       <referenceBlock name="product.info.details">
            <block class="Magento\Review\Block\Product\Review" name="reviews_tab" as="reviews" template="Namespace_Mymodule::review.phtml" group="detailed_info">
                <block class="Magento\Review\Block\Form" name="review_form" template="Namespace_Mymodule::form.phtml" as="review_form">
                    <container name="product.review.form.fields.before" as="form_fields_before" label="Review Form Fields Before"/>
                </block>
            </block>
        </referenceBlock>
    </body>
</page>

app/code/Namespace/Mymodule/view/frontend/templates

<?php
/**
 * Copyright © 2016 Magento. All rights reserved.
 * See COPYING.txt for license details.
 */

// @codingStandardsIgnoreFile

/**
 * @var $block \Magento\Review\Block\Form
 */
?>
<div class="block review-add">
    <div class="block-title"><strong><?php /* @escapeNotVerified */ echo __('Write Your Own Review') ?></strong></div>
<div class="block-content">
<?php if ($block->getAllowWriteReviewFlag()): ?>
<form action="<?php /* @escapeNotVerified */ echo $block->getAction() ?>" class="review-form" method="post" id="review-form" data-role="product-review-form" data-bind="scope: 'review-form'">
    <?php echo $block->getBlockHtml('formkey'); ?>
    <?php echo $block->getChildHtml('form_fields_before')?>
    <fieldset class="fieldset review-fieldset" data-hasrequired="<?php __('* Required Fields'); ?>">
        <legend class="legend review-legend"><span><?php /* @escapeNotVerified */ echo __("You're reviewing:"); ?></span><strong><?php echo $block->escapeHtml($block->getProductInfo()->getName()) ?></strong></legend><br />
        <?php if ($block->getRatings() && $block->getRatings()->getSize()): ?>
        <span id="input-message-box"></span>
        <fieldset class="field required review-field-ratings">
            <legend class="label"><span><?php /* @escapeNotVerified */ echo __('Your Rating') ?><span></legend><br/>
            <div class="control">
                <div class="nested" id="product-review-table">
                    <?php foreach ($block->getRatings() as $_rating): ?>
                        <div class="field choice review-field-rating">
                            <label class="label" id="<?php echo $block->escapeHtml($_rating->getRatingCode()) ?>_rating_label"><span><?php echo $block->escapeHtml($_rating->getRatingCode()) ?></span></label>
                            <div class="control review-control-vote">
                            <?php $options = $_rating->getOptions();?>
                            <?php $iterator = 1; foreach ($options as $_option): ?>
                                <input
                                    type="radio"
                                    name="ratings[<?php /* @escapeNotVerified */ echo $_rating->getId() ?>]"
                                    id="<?php echo $block->escapeHtml($_rating->getRatingCode()) ?>_<?php /* @escapeNotVerified */ echo $_option->getValue() ?>"
                                    value="<?php /* @escapeNotVerified */ echo $_option->getId() ?>"
                                    class="radio"
                                    data-validate="{required:true, messages:{required:'Please select one of each of the ratings above.'}}"
                                    aria-labelledby="<?php echo $block->escapeHtml($_rating->getRatingCode()) ?>_rating_label <?php echo $block->escapeHtml($_rating->getRatingCode()) ?>_<?php /* @escapeNotVerified */ echo $_option->getValue() ?>_label" />
                                <label
                                    class="rating-<?php /* @escapeNotVerified */ echo $iterator; ?>"
                                    for="<?php echo $block->escapeHtml($_rating->getRatingCode()) ?>_<?php /* @escapeNotVerified */ echo $_option->getValue() ?>"
                                    title="<?php /* @escapeNotVerified */ echo __('%1 %2', $iterator, $iterator > 1 ? 'stars' : 'star') ?>"
                                    id="<?php echo $block->escapeHtml($_rating->getRatingCode()) ?>_<?php /* @escapeNotVerified */ echo $_option->getValue() ?>_label">
                                    <span><?php /*@escapeNotVerified*/ echo __('%1 %2', $iterator, $iterator > 1 ? 'stars' : 'star') ?></span>
                                </label>
                            <?php $iterator++; ?>
                            <?php endforeach; ?>
                            </div>
                        </div>
                    <?php endforeach; ?>
                </div>
                <input type="hidden" name="validate_rating" class="validate-rating" value="" />
            </div>
        </fieldset>
    <?php endif ?>
        <div class="field review-field-nickname required">
            <label for="nickname_field" class="label"><span><?php /*@escapeNotVerified*/ echo __('Nickname') ?></span></label>
            <div class="control">
                <input type="text" name="nickname" id="nickname_field" class="input-text" data-validate="{required:true}" data-bind="value: nickname()" />
            </div>
        </div>
        <div class="field review-field-summary required">
            <label for="summary_field" class="label"><span><?php /*@escapeNotVerified*/ echo __('Summary') ?></span></label>
            <div class="control">
                <input type="text" name="title" id="summary_field" class="input-text" data-validate="{required:true}" data-bind="value: review().title" />
            </div>
        </div>
        <div class="field review-field-text required">
            <label for="review_field" class="label"><span><?php /*@escapeNotVerified*/ echo __('Review') ?></span></label>
            <div class="control">
                <textarea name="detail" id="review_field" cols="5" rows="3" data-validate="{required:true}" data-bind="value: review().detail"></textarea>
            </div>
        </div>
        <div class="field review-field-refer required">
          <label for="review_field" class="label"><span><?php/*@escapeNotVerified*/ echo __('Would you recommend this product to a friend') ?></span></label>
            <div class="control">
               <select name="refer_field">
               <option name="yes" value="yes">Yes</option>
               <option name="no" value="no">No</option>
               </select>
            </div>
        </div>
    </fieldset>
    <div class="actions-toolbar review-form-actions">
        <div class="primary actions-primary">
            <button type="submit" class="action submit primary"><span><?php/*@escapeNotVerified*/ echo __('Submit Review') ?></span></button>
        </div>
    </div>
</form>
<script type="text/x-magento-init">
{
    "[data-role=product-review-form]": {
        "Magento_Ui/js/core/app": <?php /* @escapeNotVerified */ echo $block->getJsLayout();?>
    },
    "#review-form": {
        "Magento_Review/js/error-placement": {}
    }
}
</script>
<?php else: ?>
    <div class="message info notlogged" id="review-form">
        <div>
            <?php /* @escapeNotVerified */ echo __('Only registered users can write reviews. Please <a href="%1">Sign in</a> or <a href="%2">create an account</a>', $block->getLoginLink(), $block->getRegisterUrl()) ?>
        </div>
    </div>
<?php endif ?>
</div>
</div>

What is the proper way to save data in the database and how to show the same field in the admin panel where review form appears?

Thanks in advance!

Best Answer

You need to overwrite the ResourceModel. At 4 am in morning I am able to figure it now :-)

Add the below XML:

<preference for="Magento\Review\Model\ResourceModel\Review" type="NS\Module\Model\ResourceModel\Review" />

and add the following php code:

<?php

namespace NS\Module\Model\ResourceModel;

use Magento\Framework\Model\AbstractModel;

/**
 * Review resource model
 */
class Review extends \Magento\Review\Model\ResourceModel\Review
{
    /**
     * Perform actions after object save
     *
     * @param \Magento\Framework\Model\AbstractModel $object
     * @return $this
     */
    protected function _afterSave(AbstractModel $object)
    {
        $connection = $this->getConnection();
        /**
         * save detail
         */
        $detail = [
            'title' => $object->getTitle(),
            'detail' => $object->getDetail(),
            'nickname' => $object->getNickname(),
            'refer_field' => $object->getReferField(),
        ];
.
.
.

Just overwrite the function "_afterSave" not the whole file.

Related Solutions

Magento 1.9 – How to Add Custom Field in Review Form

use $this instead of $object

protected function _afterSave(Mage_Core_Model_Abstract $object)
{
$detail = array(
'title' => $this->getTitle(),
'detail' => $this->getDetail(),
'nickname' => $this->getNickname(),
'email' => $this->getEmail(), // New field 1
);

Magento – Add email field to Review Form – Magento 2

Seeing as how there's no clear answer on this yet, this might help some people. To add an e-mail field (or any other field) to the frontend review form and display it in the admin we have to create a custom module.

With this module we'll:

Create a custom field in the database
Save data
Display in the admin

NOTE: Be sure to replace "Vendor" with your desired vendor name.

app\code\Vendor\ReviewEmail\registration.php

<?php

\Magento\Framework\Component\ComponentRegistrar::register(
    \Magento\Framework\Component\ComponentRegistrar::MODULE,
    'Vendor_ReviewEmail',
    __DIR__
);

app\code\Vendor\ReviewEmail\etc\module.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
    <module name="Vendor_ReviewEmail" setup_version="1.0.0">
        <sequence>
            <module name="Magento_Review" />
        </sequence>
    </module>
</config>

app\code\Vendor\ReviewEmail\etc\di.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">

    <type name="Magento\Review\Block\Adminhtml\Edit\Form">
        <plugin name="modify_review_edit_form" type="Vendor\ReviewEmail\Plugin\Magento\Review\Block\Adminhtml\Edit\Form" />
    </type>    

</config>

app\code\Vendor\ReviewEmail\etc\events.xml

<?xml version="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">

    <event name='review_save_after'>
        <observer name='vendor_reviewemail_save_after' instance='Vendor\ReviewEmail\Model\Observer\ReviewSave'/>
    </event>    

</config>

app\code\Vendor\ReviewEmail\Setup\InstallSchema.php

<?php
namespace Vendor\ReviewEmail\Setup;

use Magento\Framework\Setup\InstallSchemaInterface;
use Magento\Framework\Setup\ModuleContextInterface;
use Magento\Framework\Setup\SchemaSetupInterface;

/**
 * @codeCoverageIgnore
 */
class InstallSchema implements InstallSchemaInterface
{
    /**
     * {@inheritdoc}
     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
     */
    public function install(SchemaSetupInterface $setup, ModuleContextInterface $context)
    {
        $installer = $setup;

        $installer->startSetup();

        $installer->getConnection()->addColumn(
            $installer->getTable('review_detail'),
            'email',
            [
                'type' => \Magento\Framework\DB\Ddl\Table::TYPE_TEXT,
                'length' => 255,
                'nullable' => true,
                'comment' => 'Email address'
            ]
        );

        $setup->endSetup();

    }
}

app\code\Vendor\ReviewEmail\Model\Observer\ReviewSave.php

<?php

namespace Vendor\ReviewEmail\Model\Observer;

use Magento\Framework\Event\ObserverInterface;

class ReviewSave implements ObserverInterface
{
    public function __construct(
        \Magento\Framework\App\ResourceConnection $resource
    ) {
        $this->_resource = $resource;
    }

    public function execute(\Magento\Framework\Event\Observer $observer)
    {
        $review = $observer->getEvent()->getDataObject();
        $connection = $this->_resource;

        $tableName = $connection->getTableName('review_detail');
        $detail = [
            'email' => $review->getEmail(),
        ];

        if (empty($review->getEmail())) return;

        $select = $connection->getConnection()->select()->from($tableName)->where('review_id = :review_id');
        $detailId = $connection->getConnection()->fetchOne($select, [':review_id' => $review->getId()]);

        if ($detailId) {
            $condition = ["detail_id = ?" => $detailId];
            $connection->getConnection()->update($tableName, $detail, $condition);
        } else {
            $detail['store_id'] = $review->getStoreId();
            $detail['customer_id'] = $review->getCustomerId();
            $detail['review_id'] = $review->getId();
            $connection->getConnection()->insert($tableName, $detail);
        }   
    }
}

app\code\Vendor\ReviewEmail\Plugin\Magento\Review\Block\Adminhtml\Edit\Form.php

<?php

namespace Vendor\ReviewEmail\Plugin\Magento\Review\Block\Adminhtml\Edit;

class Form extends \Magento\Review\Block\Adminhtml\Edit\Form
{
    public function beforeSetForm(\Magento\Review\Block\Adminhtml\Edit\Form $object, $form) {

        $review = $object->_coreRegistry->registry('review_data');

        $fieldset = $form->addFieldset(
            'review_details_extra',
            ['legend' => __('Review Details Extra Data'), 'class' => 'fieldset-wide']
        );

        $fieldset->addField(
            'email',
            'text',
            ['label' => __('E-mail'), 'required' => false, 'name' => 'email']
        );

        $form->setValues($review->getData());

        return [$form];
    }
}

app\code\Vendor\ReviewEmail\view\adminhtml\ui_component\review_listing.xml (Optional, only if you want to show the field in the admin grid as well)

<?xml version="1.0" encoding="UTF-8"?>
<listing xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Ui:etc/ui_configuration.xsd">
    <columns name="review_columns">
        <column name="email">
            <argument name="data" xsi:type="array">
                <item name="config" xsi:type="array">
                    <item name="filter" xsi:type="string">text</item>
                    <item name="label" xsi:type="string" translate="true">E-mail</item>
                    <item name="sortOrder" xsi:type="number">45</item>
                    <item name="truncate" xsi:type="number">50</item>
                    <item name="nl2br" xsi:type="boolean">true</item>
                    <item name="escape" xsi:type="boolean">true</item>
                </item>
            </argument>
        </column>
    </columns>
</listing>

After this all we have left to do is add the field to the review form. In app\design\frontend\Vendor\yourtheme\Magento_Review\templates\form.phtml

<input type="text" name="email" id="email_field" class="block mb2 full-width validate-email" data-validate="{required:true}"/>

Make sure to add this between the form tags.

After installing the module and clearing your caches you should now have an e-mail field in your review form. Which should be visible in the admin grid and admin review detail view.

Best Answer

Related Solutions

Magento 1.9 – How to Add Custom Field in Review Form

Magento – Add email field to Review Form – Magento 2

Related Topic