Blame view

README.md 2.23 KB
faff2c48   Yarik   Artbox comment cr...
1
2
3
4
5
6
7
8
9
10
11
12
13
  Artbox Comment
  ===============================
  
  Artbox Comment is an extension for working with comments developed by Artweb written with [Yii 2 framework](http://www.yiiframework.com/).
  
  Comment extension includes functionality for creating and maintaining comments on the website.
  
  This extension works with Artbox Core application and enough to add fully functional comment system to the website.
  
  To prepare your application you should run migrations:
  
      php yii migrate --migationPath=vendor/artweb/artbox-webcomment/migrations
      
44dfaf88   Yarik   Artbox great prep...
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
  To use comment system with customers you need to run additional migration:
      
      php yii migrate --migationPath=vendor/artweb/artbox-webcomment/order-to-comment/migrations
      
  You also need to register artbox-comment module in your application:
  
      modules => [
          ...
          'artbox-comment' => [
              'class' => 'artbox\webcomment\Module',
              ...
          ],
          ...
      ]
      
  Available additional configurations:
  
  * enableRating - рейтинг на комментарие (default true)
  * enablePremoderate - премодерация комментариев (default true)
  * userIdentityClass - класс клиента (default \Yii::$app->user->identity)
  * commentModelClass - класс комментария (default artweb\webcomment\models\CommentModel)
  * ratingModelClass - класс рейтинга (default artweb\webcomment\models\RatingModel)
  
  
faff2c48   Yarik   Artbox comment cr...
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
  DIRECTORY STRUCTURE
  -------------------
  
  ```
  assets                   contains AssetBundles
  behaviors                contains Behaviors classes
  components               contains custom Classes, which don't belong to other groups
  controllers              contains controllers for core models
  helpers                  contains helper classes to manipulate, for example static files
                           and HTML
  messages                 contains translations for core strings
  migrations               contains migrations, which should be applied after extension
                           installation
  models                   contains core models
  views                    contains views files for core controllers
  web                      contains assets and other files, which should be web available
  widgets                  contains widgets
  ```