Add view link to comments grid view on the manage comments page.

Author: igor-chepurnoi

assets/js/comment.js

@@ -68,10 +68,12 @@
         var $commentForm = $(this);
         var settings = $commentForm.data('comment');
         var pjaxSettings = $.extend({container: settings.pjaxContainerId}, settings.pjaxSettings);
+        var formData = $commentForm.serializeArray();
+        formData.push({'name': 'CommentModel[url]', 'value': getCurrentUrl()});
 
         $commentForm.find(':submit').prop('disabled', true).text(settings.submitBtnLoadingText);
 
-        $.post($commentForm.attr("action"), $commentForm.serialize(), function (data) {
+        $.post($commentForm.attr("action"), formData, function (data) {
             if (data.status == 'success') {
                 $.pjax(pjaxSettings).done(function () {
                     $commentForm.trigger("reset");
@@ -145,4 +147,12 @@
         });
     }
 
-})(window.jQuery);
+    /**
+     * Get current url without `hostname`
+     * @returns {string}
+     */
+    function getCurrentUrl() {
+        return window.location.pathname + window.location.search;
+    }
+
+})(window.jQuery);

messages/en/yii2mod.comments.php

@@ -27,6 +27,7 @@
     'Created by' => 'Created by',
     'Updated by' => 'Related to',
     'Related to' => 'Related to',
+    'Url' => 'Url',
     'Created date' => 'Created date',
     'Updated date' => 'Updated date',
     'Update' => 'Update',
@@ -48,5 +49,5 @@
     'Update Comment: {0}' => 'Update Comment: {0}',
     'Active' => 'Active',
     'Deleted' => 'Deleted',
-    'Go Back' => 'Go Back'
+    'Go Back' => 'Go Back',
 ];

messages/ru/yii2mod.comments.php

@@ -27,6 +27,7 @@
     'Created by' => 'Создан',
     'Updated by' => 'Обновлен',
     'Related to' => 'Относится к',
+    'Url' => 'Урл',
     'Created date' => 'Дата создания',
     'Updated date' => 'Дата обновления',
     'Update' => 'Обновить',

migrations/m161114_094902_add_url_column_to_comment_table.php

@@ -0,0 +1,25 @@
+<?php
+
+use yii\db\Migration;
+
+/**
+ * Handles adding url to table `comment`.
+ */
+class m161114_094902_add_url_column_to_comment_table extends Migration
+{
+    /**
+     * @inheritdoc
+     */
+    public function up()
+    {
+        $this->addColumn('comment', 'url', $this->text()->after('relatedTo'));
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function down()
+    {
+        $this->dropColumn('comment', 'url');
+    }
+}

models/CommentModel.php

@@ -22,6 +22,7 @@
  * @property integer $createdBy
  * @property integer $updatedBy
  * @property string $relatedTo
+ * @property string $url
  * @property integer $status
  * @property integer $level
  * @property integer $createdAt
@@ -55,7 +56,7 @@ public function rules()
         return [
             [['entity', 'entityId'], 'required'],
             ['content', 'required', 'message' => Yii::t('yii2mod.comments', 'Comment cannot be blank.')],
-            [['content', 'entity', 'relatedTo'], 'string'],
+            [['content', 'entity', 'relatedTo', 'url'], 'string'],
             ['status', 'default', 'value' => CommentStatus::ACTIVE],
             ['status', 'in', 'range' => [CommentStatus::ACTIVE, CommentStatus::DELETED]],
             ['level', 'default', 'value' => 1],
@@ -129,6 +130,7 @@ public function attributeLabels()
             'createdBy' => Yii::t('yii2mod.comments', 'Created by'),
             'updatedBy' => Yii::t('yii2mod.comments', 'Updated by'),
             'relatedTo' => Yii::t('yii2mod.comments', 'Related to'),
+            'url' => Yii::t('yii2mod.comments', 'Url'),
             'createdAt' => Yii::t('yii2mod.comments', 'Created date'),
             'updatedAt' => Yii::t('yii2mod.comments', 'Updated date'),
         ];
@@ -383,4 +385,28 @@ public function getCommentsCount($onlyActiveComments = true)
 
         return $query->count();
     }
-}
+
+    /**
+     * Get anchor url for comment
+     *
+     * @return string
+     */
+    public function getAnchorUrl()
+    {
+        return "#comment-{$this->id}";
+    }
+
+    /**
+     * Get view comment url
+     *
+     * @return null|string
+     */
+    public function getViewUrl()
+    {
+        if (!empty($this->url)) {
+            return $this->url . $this->getAnchorUrl();
+        }
+
+        return null;
+    }
+}

tests/TestCase.php

@@ -104,6 +104,7 @@ protected function setupTestDbData()
             'createdBy' => 'integer not null',
             'updatedBy' => 'integer not null',
             'relatedTo' => 'string(500) not null',
+            'url' => 'text',
             'status' => 'smallint not null default 1',
             'createdAt' => 'integer not null',
             'updatedAt' => 'integer not null',
@@ -131,6 +132,7 @@ protected function setupTestDbData()
             'createdBy' => 1,
             'updatedBy' => 1,
             'relatedTo' => 'test comment',
+            'url' => 'custom-url',
             'createdAt' => time(),
             'updatedAt' => time()
         ])->execute();
@@ -154,4 +156,4 @@ protected function createRuntimeFolder()
     {
         FileHelper::createDirectory(dirname(__DIR__) . '/tests/runtime');
     }
-}
+}

views/manage/index.php

@@ -4,6 +4,7 @@
 use yii\helpers\Html;
 use yii\helpers\Json;
 use yii\helpers\StringHelper;
+use yii\helpers\Url;
 use yii\widgets\Pjax;
 use yii2mod\comments\models\enums\CommentStatus;
 use yii2mod\editable\EditableColumn;
@@ -71,7 +72,26 @@
             [
                 'header' => 'Actions',
                 'class' => 'yii\grid\ActionColumn',
-                'template' => '{update}{delete}',
+                'template' => '{view}{update}{delete}',
+                'buttons' => [
+                    'view' => function ($url, $model, $key) {
+                        $title = Yii::t('yii2mod.comments', 'View');
+                        $options = [
+                            'title' => $title,
+                            'aria-label' => $title,
+                            'data-pjax' => '0',
+                            'target' => '_blank'
+                        ];
+                        $icon = Html::tag('span', '', ['class' => 'glyphicon glyphicon-eye-open']);
+                        $url = $model->getViewUrl();
+
+                        if (!empty($url)) {
+                            return Html::a($icon, $url, $options);
+                        }
+
+                        return null;
+                    }
+                ]
             ]
         ],
     ]);

widgets/views/_list.php

@@ -30,7 +30,7 @@
                     <?php echo Html::tag('meta', null, ['content' => Yii::$app->formatter->asDatetime($comment->updatedAt, 'php:c'), 'itemprop' => 'dateModified']); ?>
                     <div class="comment-author-name" itemprop="creator" itemscope itemtype="http://schema.org/Person">
                         <span itemprop="name"><?php echo $comment->getAuthorName(); ?></span>
-                        <?php echo Html::a($comment->getPostedDate(), "#comment-{$comment->id}", ['class' => 'comment-date']); ?>
+                        <?php echo Html::a($comment->getPostedDate(), $comment->getAnchorUrl(), ['class' => 'comment-date']); ?>
                     </div>
                     <div class="comment-body" itemprop="text">
                         <?php echo $comment->getContent(); ?>
@@ -44,4 +44,4 @@
             <?php endif; ?>
         </li>
     <?php endforeach; ?>
-<?php endif; ?>
+<?php endif; ?>