add ability to edit comments on frontend

Author: Igor Chepurnoy

CommentAsset.php

@@ -12,26 +12,26 @@
 class CommentAsset extends AssetBundle
 {
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public $sourcePath = '@vendor/yii2mod/yii2-comments/assets';
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public $js = [
         'js/comment.js',
     ];
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public $css = [
         'css/comment.css',
     ];
 
     /**
-     * {@inheritdoc}
+     * @inheritdoc
      */
     public $depends = [
         'yii\web\JqueryAsset',

Module.php

@@ -11,11 +11,6 @@
  */
 class Module extends \yii\base\Module
 {
-    /**
-     * @var string module name
-     */
-    public static $name = 'comment';
-
     /**
      * @var string the class name of the [[identity]] object
      */
@@ -31,6 +26,11 @@ class Module extends \yii\base\Module
      */
     public $controllerNamespace = 'yii2mod\comments\controllers';
 
+    /**
+     * @var bool whether admin can edit comment on frontend
+     */
+    public $enableInlineEdit = false;
+
     /**
      * {@inheritdoc}
      */

controllers/DefaultController.php

@@ -3,6 +3,7 @@
 namespace yii2mod\comments\controllers;
 
 use Yii;
+use yii\filters\AccessControl;
 use yii\filters\VerbFilter;
 use yii\helpers\Json;
 use yii\web\BadRequestHttpException;
@@ -12,8 +13,8 @@
 use yii\widgets\ActiveForm;
 use yii2mod\comments\events\CommentEvent;
 use yii2mod\comments\models\CommentModel;
-use yii2mod\comments\Module;
-use yii2mod\moderation\ModerationBehavior;
+use yii2mod\comments\traits\ModuleTrait;
+use yii2mod\editable\EditableAction;
 
 /**
  * Class DefaultController
@@ -22,6 +23,8 @@
  */
 class DefaultController extends Controller
 {
+    use ModuleTrait;
+
     /**
      * Event is triggered before creating a new comment.
      * Triggered with yii2mod\comments\events\CommentEvent
@@ -46,12 +49,35 @@ class DefaultController extends Controller
      */
     const EVENT_AFTER_DELETE = 'afterDelete';
 
+    /**
+     * @inheritdoc
+     */
+    public function actions()
+    {
+        return [
+            'quick-edit' => [
+                'class' => EditableAction::class,
+                'modelClass' => CommentModel::class,
+            ],
+        ];
+    }
+
     /**
      * @inheritdoc
      */
     public function behaviors()
     {
         return [
+            'access' => [
+                'class' => AccessControl::class,
+                'only' => ['quick-edit'],
+                'rules' => [
+                    [
+                        'allow' => true,
+                        'roles' => ['admin'],
+                    ],
+                ],
+            ],
             'verbs' => [
                 'class' => VerbFilter::class,
                 'actions' => [
@@ -79,7 +105,7 @@ public function behaviors()
     public function actionCreate($entity)
     {
         /* @var $commentModel CommentModel */
-        $commentModel = Yii::createObject(Yii::$app->getModule(Module::$name)->commentModelClass);
+        $commentModel = Yii::createObject($this->getModule()->commentModelClass);
         $event = Yii::createObject(['class' => CommentEvent::class, 'commentModel' => $commentModel]);
         $commentModel->setAttributes($this->getCommentAttributesFromEntity($entity));
         $this->trigger(self::EVENT_BEFORE_CREATE, $event);
@@ -124,15 +150,14 @@ public function actionDelete($id)
      *
      * @param int|array $id Comment ID
      *
-     * @return null|CommentModel|ModerationBehavior
+     * @return CommentModel
      *
      * @throws NotFoundHttpException
      */
     protected function findModel($id)
     {
-        /** @var CommentModel $model */
-        $commentModelClass = Yii::$app->getModule(Module::$name)->commentModelClass;
-        if (($model = $commentModelClass::findOne($id)) !== null) {
+        $commentModel = $this->getModule()->commentModelClass;
+        if (($model = $commentModel::findOne($id)) !== null) {
             return $model;
         } else {
             throw new NotFoundHttpException(Yii::t('yii2mod.comments', 'The requested page does not exist.'));
@@ -150,7 +175,7 @@ protected function findModel($id)
      */
     protected function getCommentAttributesFromEntity($entity)
     {
-        $decryptEntity = Yii::$app->getSecurity()->decryptByKey(utf8_decode($entity), Module::$name);
+        $decryptEntity = Yii::$app->getSecurity()->decryptByKey(utf8_decode($entity), $this->getModule()->id);
         if ($decryptEntity !== false) {
             return Json::decode($decryptEntity);
         }

controllers/ManageController.php

@@ -2,13 +2,12 @@
 
 namespace yii2mod\comments\controllers;
 
-use paulzi\adjacencyList\AdjacencyListBehavior;
 use Yii;
 use yii\filters\VerbFilter;
 use yii\web\Controller;
 use yii\web\NotFoundHttpException;
 use yii2mod\comments\models\CommentModel;
-use yii2mod\comments\Module;
+use yii2mod\comments\traits\ModuleTrait;
 
 /**
  * Class ManageController
@@ -17,6 +16,8 @@
  */
 class ManageController extends Controller
 {
+    use ModuleTrait;
+
     /**
      * @var string path to index view file, which is used in admin panel
      */
@@ -58,7 +59,7 @@ public function actionIndex()
     {
         $searchModel = Yii::createObject($this->searchClass);
         $dataProvider = $searchModel->search(Yii::$app->request->queryParams);
-        $commentModel = Yii::$app->getModule(Module::$name)->commentModelClass;
+        $commentModel = $this->getModule()->commentModelClass;
 
         return $this->render($this->indexView, [
             'dataProvider' => $dataProvider,
@@ -117,11 +118,11 @@ public function actionDelete($id)
      *
      * @throws NotFoundHttpException if the model cannot be found
      *
-     * @return CommentModel|AdjacencyListBehavior the loaded model
+     * @return CommentModel
      */
     protected function findModel($id)
     {
-        $commentModel = Yii::$app->getModule(Module::$name)->commentModelClass;
+        $commentModel = $this->getModule()->commentModelClass;
 
         if (($model = $commentModel::findOne($id)) !== null) {
             return $model;

models/CommentModel.php

@@ -10,7 +10,7 @@
 use yii\db\ActiveRecord;
 use yii\helpers\ArrayHelper;
 use yii2mod\behaviors\PurifyBehavior;
-use yii2mod\comments\Module;
+use yii2mod\comments\traits\ModuleTrait;
 use yii2mod\moderation\enums\Status;
 use yii2mod\moderation\ModerationBehavior;
 use yii2mod\moderation\ModerationQuery;
@@ -35,9 +35,13 @@
  * @method ActiveRecord makeRoot()
  * @method ActiveRecord appendTo($node)
  * @method ActiveQuery getDescendants()
+ * @method ModerationBehavior markRejected()
+ * @method AdjacencyListBehavior deleteWithChildren()
  */
 class CommentModel extends ActiveRecord
 {
+    use ModuleTrait;
+
     /**
      * @var null|array|ActiveRecord[] comment children
      */
@@ -166,7 +170,7 @@ public function beforeSave($insert)
         if (parent::beforeSave($insert)) {
             if ($this->parentId > 0) {
                 $parentNodeLevel = static::find()->select('level')->where(['id' => $this->parentId])->scalar();
-                $this->level = $parentNodeLevel + 1;
+                $this->level += $parentNodeLevel;
             }
 
             return true;
@@ -214,9 +218,7 @@ public function saveComment()
      */
     public function getAuthor()
     {
-        $module = Yii::$app->getModule(Module::$name);
-
-        return $this->hasOne($module->userIdentityClass, ['id' => 'createdBy']);
+        return $this->hasOne($this->getModule()->userIdentityClass, ['id' => 'createdBy']);
     }
 
     /**

models/search/CommentSearch.php

@@ -23,7 +23,8 @@ class CommentSearch extends CommentModel
     public function rules()
     {
         return [
-            [['id', 'createdBy', 'content', 'status', 'relatedTo'], 'safe'],
+            [['id', 'createdBy', 'status'], 'integer'],
+            [['content', 'relatedTo'], 'safe'],
         ];
     }
 
@@ -34,7 +35,7 @@ public function rules()
      *
      * @return ActiveDataProvider
      */
-    public function search($params)
+    public function search(array $params)
     {
         $query = CommentModel::find();
 
@@ -49,15 +50,18 @@ public function search($params)
             'defaultOrder' => ['id' => SORT_DESC],
         ]);
 
-        // load the search form data and validate
-        if (!($this->load($params))) {
+        $this->load($params);
+
+        if (!$this->validate()) {
             return $dataProvider;
         }
 
-        // adjust the query by adding the filters
-        $query->andFilterWhere(['id' => $this->id]);
-        $query->andFilterWhere(['createdBy' => $this->createdBy]);
-        $query->andFilterWhere(['status' => $this->status]);
+        $query->andFilterWhere([
+            'id' => $this->id,
+            'createdBy' => $this->createdBy,
+            'status' => $this->status,
+        ]);
+
         $query->andFilterWhere(['like', 'content', $this->content]);
         $query->andFilterWhere(['like', 'relatedTo', $this->relatedTo]);
 

traits/ModuleTrait.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace yii2mod\comments\traits;
+
+use Yii;
+use yii2mod\comments\Module;
+
+/**
+ * Class ModuleTrait
+ *
+ * @package yii2mod\comments\traits
+ */
+trait ModuleTrait
+{
+    /**
+     * @return Module
+     */
+    public function getModule()
+    {
+        return Yii::$app->getModule('comment');
+    }
+}

views/manage/index.php

@@ -8,7 +8,7 @@
 
 /* @var $this yii\web\View */
 /* @var $dataProvider yii\data\ActiveDataProvider */
-/* @var $searchModel \yii2mod\comments\models\CommentSearchModel */
+/* @var $searchModel \yii2mod\comments\models\search\CommentSearch */
 /* @var $commentModel \yii2mod\comments\models\CommentModel */
 
 $this->title = Yii::t('yii2mod.comments', 'Comments Management');

widgets/Comment.php

@@ -9,7 +9,7 @@
 use yii\helpers\Json;
 use yii2mod\comments\CommentAsset;
 use yii2mod\comments\models\CommentModel;
-use yii2mod\comments\Module;
+use yii2mod\comments\traits\ModuleTrait;
 
 /**
  * Class Comment
@@ -18,6 +18,8 @@
  */
 class Comment extends Widget
 {
+    use ModuleTrait;
+
     /**
      * @var \yii\db\ActiveRecord|null Widget model
      */
@@ -134,7 +136,7 @@ public function init()
      */
     public function run()
     {
-        $commentClass = Yii::$app->getModule(Module::$name)->commentModelClass;
+        $commentClass = $this->getModule()->commentModelClass;
         $commentModel = Yii::createObject([
             'class' => $commentClass,
             'entity' => $this->entity,
@@ -165,7 +167,7 @@ protected function getEncryptedEntity()
             'entity' => $this->entity,
             'entityId' => $this->entityId,
             'relatedTo' => $this->relatedTo,
-        ]), Module::$name));
+        ]), $this->getModule()->id));
     }
 
     /**

widgets/views/_list.php

@@ -2,6 +2,7 @@
 
 use yii\helpers\Html;
 use yii\helpers\Url;
+use yii2mod\editable\Editable;
 
 /* @var $this \yii\web\View */
 /* @var $model \yii2mod\comments\models\CommentModel */
@@ -26,7 +27,18 @@
                 <?php echo Html::a($model->getPostedDate(), $model->getAnchorUrl(), ['class' => 'comment-date']); ?>
             </div>
             <div class="comment-body">
-                <?php echo $model->getContent(); ?>
+                <?php if (Yii::$app->getModule('comment')->enableInlineEdit): ?>
+                    <?php echo Editable::widget([
+                        'model' => $model,
+                        'attribute' => 'content',
+                        'url' => '/comment/default/quick-edit',
+                        'options' => [
+                            'id' => 'editable-comment-' . $model->id,
+                        ]
+                    ]); ?>
+                <?php else: ?>
+                    <?php echo $model->getContent(); ?>
+                <?php endif; ?>
             </div>
         </div>
     </div>