add relatedTo attribute to CommentModel

Author: Igor Chepurnoy

Module.php

@@ -2,6 +2,7 @@
 
 namespace yii2mod\comments;
 
+use Yii;
 use yii2mod\comments\models\CommentModel;
 
 /**
@@ -45,7 +46,7 @@ class Module extends \yii\base\Module
     public function init()
     {
         if ($this->userIdentityClass === null) {
-            $this->userIdentityClass = \Yii::$app->getUser()->identityClass;
+            $this->userIdentityClass = Yii::$app->getUser()->identityClass;
         }
         if ($this->commentModelClass === null) {
             $this->commentModelClass = CommentModel::className();

controllers/DefaultController.php

@@ -51,10 +51,8 @@ public function actionCreate($entity)
         if ($decryptEntity !== false) {
             $entityData = Json::decode($decryptEntity);
             /* @var $model CommentModel */
-            $model = new $commentModelClass([
-                'entity' => $entityData['entity'],
-                'entityId' => $entityData['entityId'],
-            ]);
+            $model = new $commentModelClass;
+            $model->setAttributes($entityData);
             if ($model->load(Yii::$app->request->post()) && $model->save()) {
                 return ['status' => 'success'];
             } else {

migrations/m010101_100001_init_comment.php

@@ -27,6 +27,7 @@ public function up()
             'level' => 'TINYINT(3) NOT NULL DEFAULT 1',
             'createdBy' => Schema::TYPE_INTEGER . ' NOT NULL',
             'updatedBy' => Schema::TYPE_INTEGER . ' NOT NULL',
+            'relatedTo' => $this->string(500)->notNull(),
             'status' => 'TINYINT(2) NOT NULL DEFAULT 1',
             'createdAt' => Schema::TYPE_INTEGER . ' NOT NULL',
             'updatedAt' => Schema::TYPE_INTEGER . ' NOT NULL',

models/CommentModel.php

@@ -22,6 +22,7 @@
  * @property string $content
  * @property integer $createdBy
  * @property integer $updatedBy
+ * @property string $relatedTo
  * @property integer $status
  * @property integer $level
  * @property integer $createdAt
@@ -52,7 +53,7 @@ public function rules()
     {
         return [
             [['entity', 'entityId', 'content'], 'required'],
-            [['content', 'entity'], 'string'],
+            [['content', 'entity', 'relatedTo'], 'string'],
             ['parentId', 'validateParentID'],
             [['entityId', 'parentId', 'createdBy', 'updatedBy', 'status', 'createdAt', 'updatedAt', 'level'], 'integer'],
         ];
@@ -113,6 +114,7 @@ public function attributeLabels()
             'level' => Yii::t('app', 'Level'),
             'createdBy' => Yii::t('app', 'Created by'),
             'updatedBy' => Yii::t('app', 'Updated by'),
+            'relatedTo' => Yii::t('app', 'Related to'),
             'createdAt' => Yii::t('app', 'Created date'),
             'updatedAt' => Yii::t('app', 'Updated date'),
         ];
@@ -294,15 +296,6 @@ public function getAvatar($imgOptions = [])
         return Html::img("http://gravatar.com/avatar/{$this->author->id}/?s=50", $imgOptions);
     }
 
-    /**
-     * Return hash value of class name
-     * @param $className
-     * @return string
-     */
-    public static function hashEntityClass($className)
-    {
-        return hash('crc32', $className);
-    }
 
     /**
      * This function used for filter in gridView, for attribute `createdBy`.

models/CommentSearchModel.php

@@ -18,7 +18,7 @@ class CommentSearchModel extends CommentModel
     public function rules()
     {
         return ArrayHelper::merge([
-            [['id', 'createdBy', 'content', 'status'], 'safe'],
+            [['id', 'createdBy', 'content', 'status', 'relatedTo'], 'safe'],
         ], parent::rules());
     }
 
@@ -52,6 +52,7 @@ public function search($params, $pageSize = 20)
         $query->andFilterWhere(['createdBy' => $this->createdBy]);
         $query->andFilterWhere(['status' => $this->status]);
         $query->andFilterWhere(['like', 'content', $this->content]);
+        $query->andFilterWhere(['like', 'relatedTo', $this->relatedTo]);
 
         return $dataProvider;
     }

views/manage/index.php

@@ -3,13 +3,15 @@
 use yii\grid\GridView;
 use yii\helpers\Html;
 use yii\helpers\Json;
+use yii\helpers\StringHelper;
 use yii\widgets\Pjax;
 use yii2mod\comments\models\enums\CommentStatus;
 use yii2mod\editable\EditableColumn;
 
 /* @var $this yii\web\View */
 /* @var $dataProvider yii\data\ActiveDataProvider */
 /* @var $searchModel \yii2mod\comments\models\CommentSearchModel */
+/* @var $commentModel \yii2mod\comments\models\CommentModel */
 
 $this->title = Yii::t('app', 'Comments Management');
 $this->params['breadcrumbs'][] = $this->title;
@@ -30,9 +32,10 @@
                 'attribute' => 'content',
                 'contentOptions' => ['style' => 'max-width: 350px;'],
                 'value' => function ($model) {
-                    return \yii\helpers\StringHelper::truncate($model->content, 100);
+                    return StringHelper::truncate($model->content, 100);
                 }
             ],
+            'attribute' => 'relatedTo',
             [
                 'attribute' => 'createdBy',
                 'value' => function ($model) {

widgets/Comment.php

@@ -20,6 +20,12 @@ class Comment extends Widget
      */
     public $model;
 
+    /**
+     * @var string relatedTo custom text, for example: cms url: about-us, john comment about us page, etc.
+     * By default - className:primaryKey of the current model
+     */
+    public $relatedTo = '';
+
     /**
      * @var string the view file that will render the comment tree and form for posting comments.
      */
@@ -46,21 +52,47 @@ class Comment extends Widget
     public $clientOptions = [];
 
     /**
-     * @var null pjax container id
+     * @var string hash(crc32) from class name of the widget model
+     */
+    protected $entity;
+
+    /**
+     * @var integer primary key value of the widget model
+     */
+    protected $entityId;
+
+    /**
+     * @var string encrypted entity key from params: entity, entityId, relatedTo
      */
-    private $pjaxContainerId = null;
+    protected $encryptedEntityKey;
 
     /**
-     * Initializes the object.
-     * This method is invoked at the end of the constructor after the object is initialized with the
-     * given configuration.
+     * @var string pjax container id, generated automatically
+     */
+    protected $pjaxContainerId;
+
+    /**
+     * Initializes the widget params.
      */
     public function init()
     {
-        if ($this->model === null) {
+        if (empty($this->model)) {
             throw new InvalidConfigException('The "model" property must be set.');
         }
         $this->pjaxContainerId = 'comment-pjax-container-' . $this->getId();
+        $this->entity = hash('crc32', get_class($this->model));
+        $this->entityId = $this->model->{$this->entityIdAttribute};
+        if (empty($this->entityId)) {
+            throw new InvalidConfigException('The "entityIdAttribute" value for widget model cannot be empty.');
+        }
+        if (empty($this->relatedTo)) {
+            $this->relatedTo = get_class($this->model) . ':' . $this->entityId;
+        }
+        $this->encryptedEntityKey = Yii::$app->getSecurity()->encryptByKey(Json::encode([
+            'entity' => $this->entity,
+            'entityId' => $this->entityId,
+            'relatedTo' => $this->relatedTo
+        ]), Module::$name);
         $this->registerAssets();
     }
 
@@ -72,27 +104,15 @@ public function run()
     {
         /* @var $module Module */
         $module = Yii::$app->getModule(Module::$name);
-        //Get comment model class from `comment` Module
         $commentModelClass = $module->commentModelClass;
-        //Get entity from widget and hash it.
-        $entity = $this->model;
-        $entityId = $entity->{$this->entityIdAttribute};
-        $entity = hash('crc32', $entity::className());
-        //Get comment tree by entity and entityId
-        $comments = $commentModelClass::getTree($entity, $entityId, $this->maxLevel);
-        //Create comment model
         $commentModel = Yii::createObject($commentModelClass);
-        //Encrypt entity and entityId values
-        $encryptedEntity = Yii::$app->getSecurity()->encryptByKey(Json::encode([
-            'entity' => $entity,
-            'entityId' => $entityId
-        ]), $module::$name);
+        $comments = $commentModelClass::getTree($this->entity, $this->entityId, $this->maxLevel);
 
         return $this->render($this->commentView, [
             'comments' => $comments,
             'commentModel' => $commentModel,
             'maxLevel' => $this->maxLevel,
-            'encryptedEntity' => $encryptedEntity,
+            'encryptedEntity' => $this->encryptedEntityKey,
             'pjaxContainerId' => $this->pjaxContainerId,
             'formId' => $this->formId
         ]);