To use Elephants Group like module first you must install module, then you can use like widget anywhere in your website., (*1)
Installation Steps:
1) run, (*2)
php composer.phar require elephantsgroup/eg-like "*", (*3)
or add "elephantsgroup/eg-like": "*"
to the require section of your composer.json file., (*4)
2) migrate database, (*5)
yii migrate --migrationPath=vendor/elephantsgroup/eg-like/migrations, (*6)
3) add like module to common configuration (common/config.php file), (*7)
'modules' => [
...
'like' => [
'class' => 'elephantsGroup\like\Module',
],
...
]
, (*8)
4) open access to module in common configuration, (*9)
'as access' => [
'class' => 'mdm\admin\components\AccessControl',
'allowActions' => [
...
'like/ajax/*',
...
]
]
, (*10)
5) filter admin controller in frontend configuration (frontend/config.php file), (*11)
'modules' => [
...
'like' => [
'as frontend' => 'elephantsGroup\like\filters\FrontendFilter',
],
...
]
, (*12)
5) filter ajax controller in backend configuration (backend/config.php file), (*13)
'modules' => [
...
'like' => [
'as backend' => 'elephantsGroup\like\filters\BackendFilter',
],
...
]
, (*14)
Anywhere in your code you can use like widget as follows:
<?= Likes::widget() ?>
, (*15)
You need to use Likes widget header in your page:
use elephantsGroup\like\components\Likes;
, (*16)
- item (integer): to separate likes between different items.
<?= Likes::widget(['item' => 1]) ?>
<?= Likes::widget(['item' => $model->id]) ?>
default value for item is 0
- service (integer): to separate likes between various item types.
<?= Likes::widget(['service' => 1, 'item' => $model->id]) ?>
, (*17)
for example you can use different values for different modules in your app, and then use like widget separately in modules.
default value for service is 0
- color (string): color of unliked icon heart, default 'black'
<?= Likes::widget(['service' => 1, ''item' => $model->id, 'color' => 'yellow']) ?>
, (*18)
- view_file (string): the view file path for rendering
<?= Likes::widget([
'service' => 1,
'item' => $model->id,
'color' => 'yellow',
'view_file' => Yii::getAlias('@frontend') . '/views/like/widget.php'
]) ?>
, (*19)
you can use these variables in your customized view:
* service
* item
* color
* is_like, (*20)