README

Yii2-Start 评论模块。

此模块为 Yii2-Start 应用程序提供了一个评论管理系统。

安装

通过 composer 安装此扩展是首选方式。

可以运行

php composer.phar require --prefer-dist vova07/yii2-start-comments-module "*"

或者将以下内容添加到你的 composer.json 文件的 require 部分中。

"vova07/yii2-start-comments-module": "*"

to the require section of your composer.json file.

配置

• 将模块添加到配置部分

'modules' => [
    'comments' => [
        'class' => 'vova07\comments\Module'
    ]
]

• 运行迁移

php yii migrate --migrationPath=@vova07/comments/migrations

• 运行 RBAC 命令

php yii comments/rbac/add

使用

• 在 yii2-start.domain/backend/comments/models/index/ 目录下添加一个可评论的新模型 namespace
• 在你的视图文件中添加 Comments 小部件

echo \vova07\comments\widgets\Comments::widget(  
    [  
        'model' => $model,  
        'jsOptions' => [  
            'listSelector' => '[data-comment="list"]', // Comment list selector 
            'parentSelector' => '[data-comment="parent"]', // Comment parent selector
            'appendSelector' => '[data-comment="append"]', // Container selector where "reply" and "edit" form will be appended by jQuery
            'formSelector' => '[data-comment="form"]', // Comment form selector
            'contentSelector' => '[data-comment="content"]', // Comment content selector
            'toolsSelector' => '[data-comment="tools"]', // Comment tools selector
            'formGroupSelector' => '[data-comment="form-group"]', // Comment form group selector
            'errorSummarySelector' => '[data-comment="form-summary"]', // Comment form summary error selector
            'errorSummaryToggleClass' => 'hidden', // Comment summary error class that will be add/remove by jQuery on error reporting
            'errorClass' => 'has-error', // Comment form group error class
            'offset' => 0 // Top offset for scrollTo function. Use it if you have fixed top menu for correct scrolling to comment's parent. In case with fixed menu, "offset" value must be equal with menu block height.
        ]  
    ]  
);

• 完成！