wdmg/yii2-comments

Tree comments system

2.0.0 2023-06-25 12:19 UTC

Requires

• wdmg/yii2-base: ^1.2.4
• wdmg/yii2-helpers: ^1.3.3
• wdmg/yii2-selectinput: ^1.0.9
• yiisoft/yii2: ^2.0.40

MIT

• Alexsander Vyshnyvetskyy
• W.D.M.Group, Ukraine

• yii2
• yii2-comments
• wdmg
• comments system

README

Yii2 Comments Module

Tree comments system for Yii2 with widget. The functionality of the module allows you to manage user comments with pre-moderation or automatic approval for registered users.

This module is an integral part of the Butterfly.СMS content management system, but can also be used as an standalone extension.

Copyrights (c) 2019-2023 W.D.M.Group, Ukraine

Requirements

• PHP 5.6 or higher
• Yii2 v.2.0.40 and newest
• Yii2 Base module (required)
• Yii2 SelectInput widget
• Yii2 Users module (optionaly)

Installation

To install the module, run the following command in the console:

$ composer require "wdmg/yii2-comments"

After configure db connection, run the following command in the console:

$ php yii comments/init

And select the operation you want to perform:

1. Apply all module migrations
2. Revert all module migrations

Migrations

In any case, you can execute the migration and create the initial data, run the following command in the console:

$ php yii migrate --migrationPath=@vendor/wdmg/yii2-comments/migrations

Configure

To add a module to the project, add the following data in your configuration file:

'modules' => [
    ...
    'comments' => [
        'class' => 'wdmg\comments\Module',
        'routePrefix' => "admin",
        'defaultController' => "admin/comments/default",
        'baseRoute' => "/comments",
        'defaultListView' => "@vendor/wdmg/yii2-comments/widgets/views/_list",
        'defaultFormView' => "@vendor/wdmg/yii2-comments/widgets/views/_form",
        'editCommentTimeout' => 300,
        'deleteCommentTimeout' => 3600,
        'newCommentsModeration' => true,
        'approveFromRegistered' => true
    ],
    ...
],

Usecase

Use the CommentsWidget::widget() to render comment`s list by context and target.

<?php
    echo \wdmg\comments\widgets\CommentsWidget::widget([
        'context' => 'page-comments',
        'target' => 'site/index'
    ]);
?>

Routing

Use the Module::dashboardNavItems() method of the module to generate a navigation items list for NavBar, like this:

<?php
    echo Nav::widget([
    'options' => ['class' => 'navbar-nav navbar-right'],
        'label' => 'Modules',
        'items' => [
            Yii::$app->getModule('comments')->dashboardNavItems(),
            ...
        ]
    ]);
?>

Status and version [ready to use]

• v.2.0.0 - Update copyrights, fix nav menu
• v.1.0.3 - Added counter stats method
• v.1.0.2 - Fixed mysql syntax error: 1055 for >= MySQL 5.7
• v.1.0.1 - Update README.md