README

Yii2 简单评论小部件

安装

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

运行以下命令之一

php composer.phar require --prefer-dist aka03/yii2-comments "*"

或者在您的 composer.json 文件的 require 部分添加

"aka03/yii2-comments": "*"

。

迁移

php yii migrate --migrationPath=@vendor/aka03/yii2-comments/src/migrations

使用方法

扩展安装完成后，只需在代码中使用即可

<?= \aka03\comments\CommentWidget::widget([
    'page' => $this->context->id,
    'page_id' => $model->id,
]); ?>

如果您想在模块中使用此小部件，请将 page 属性更改为

'page' => $this->context->module->id

属性

page 用于指示显示评论的当前控制器。

page_id 用于指示当前 id。如果设置了此属性，则每个 page 都将有自己的评论。

例如，如果当前路由 = 'site/about'，您可以添加以下代码

<?= \aka03\comments\CommentWidget::widget([
    'page' => 'site',
    'page_id' => 'about'
]); ?>

对于简单的 page，您可以设置 page_id = null，或者根本不设置。

<?= \aka03\comments\CommentWidget::widget([
    'page' => 'about'
]); ?>

guestCanLeaveComment (布尔值，默认 = true)。如果用户未登录，则无法发表评论。

showCommentsForGuests (布尔值，默认 = true)。显示访客用户的评论 ()。

showRelativeTime (布尔值，默认 = true)。显示相对时间。False 表示将显示 datetime。

avatarField (字符串，默认 = 'avatar')。数据库中的用户头像字段。如果找不到此字段，则将使用默认头像。

完整代码应如下所示

<?= \aka03\comments\CommentWidget::widget([
    'page' => $this->context->id,
    'page_id' => $model->id,
    'guestCanLeaveComment' => true,
    'showCommentsForGuests' => true,
    'showRelativeTime' => true,
    'avatarField' => 'avatar',
]); ?>

测试

codecept run

为了覆盖率，请在 indet-test.php 文件中添加以下行，在 Application->run() 之前。

include dirname(dirname(__DIR__)) . '/vendor/aka03/yii2-comments/c3.php';

define('MY_APP_STARTED', true);

在 codeception.yml 文件中，将 c3_url 更改为 frontend/index-test.php。 (例如 https:///index-test.php)。

对于验收测试

• 请勿忘记安装 selenium-server;
• 在 tests/acceptance.suite.yml 文件中更改 url;
• 在测试配置文件中添加以下行

'bootstrap' => [
    'aka03\comments\modules\testPage\Bootstrap'
],
'modules' => [
    'testPage' => [
        'class' => 'aka03\comments\modules\testPage\Module',
    ],
]