elephantsgroup/eg-star-rating

Yii2 star rating module

To use Elephants Group star-rating module first you must install module, then you can use star-rating widget anywhere in your website., _(*1)

Installation Steps:

1) run, _(*2)

php composer.phar require elephantsgroup/eg-star-rating "*", _(*3)

or add "elephantsgroup/eg-star-rating": "~1" to the require section of your composer.json file., _(*4)

2) migrate database, _(*5)

yii migrate --migrationPath=vendor/elephantsgroup/eg-star-rating/migrations, _(*6)

3) add star-rating module to common configuration (common/config.php file), _(*7)

'modules' => [ ... 'star-rating' => [ 'class' => 'elephantsGroup\starRating\Module', ], ... ], _(*8)

4) open access to module in common configuration, _(*9)

'as access' => [ 'class' => 'mdm\admin\components\AccessControl', 'allowActions' => [ ... 'star-rating/ajax/*', ... ] ], _(*10)

5) filter admin controller in frontend configuration (frontend/config.php file), _(*11)

'modules' => [ ... 'star-rating' => [ 'as frontend' => 'elephantsGroup\starRating\filters\FrontendFilter', ], ... ], _(*12)

5) filter ajax controller in backend configuration (backend/config.php file), _(*13)

'modules' => [ ... 'star-rating' => [ 'as backend' => 'elephantsGroup\starRating\filters\BackendFilter', ], ... ], _(*14)

Using star-rating widget

Anywhere in your code you can use star-rating widget as follows: <?= Rate::widget() ?>, _(*15)

You need to use Rate widget header in your page: use elephantsGroup\starRating\components\Rate;, _(*16)

Rate widget parameters

• item (integer): to separate Rate between different items. <?= Rate::widget(['item' => 1]) ?> <?= Rate::widget(['item' => $model->id]) ?>

default value for item is 0 - service (integer): to separate star-rating between various item types. <?= Rate::widget(['service' => 1, 'item' => $model->id]) ?>, _(*17)

for example you can use different values for different modules in your app, and then use star-rating widget separately in modules. default value for service is 0 - min_num (integer): minimum possible rate vote <?= Rate::widget(['service' => 1, ''item' => $model->id, 'min_num' => 1]) ?>, _(*18)

• max_num (integer): maximum possible rate vote <?= Rate::widget(['service' => 1, ''item' => $model->id, 'min_num' => 1, 'max_num' => 5]) ?>, _(*19)

• view_file (string): the view file path for rendering, _(*20)

<?= Rate::widget([ 'service' => 1, 'item' => $model->id, 'color' => 'yellow', 'view_file' => Yii::getAlias('@frontend') . '/views/star-rating/widget.php' ]) ?>, _(*21)

you can use these variables in your customized view: * service * item * min_num * max_num * rate_num, _(*22)