komer45 / yii2-balance
its a balance module
Installs: 161
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 1
Open Issues: 0
Type:yii2-extension
Requires
- php: >=5.4.0
- yiisoft/yii2: *
- yiisoft/yii2-bootstrap: *
Requires (Dev)
This package is not auto-updated.
Last update: 2024-10-07 14:32:51 UTC
README
Это модуль для реализации кошелька пользователя. Кошелек создается автоматически для нового пользователя, так же можно создать кошелек для уже существующего пользователя, или для всех пользователей, у которых еще нет кошелька, по нажатию на соответствующую кнопку на странице кошельков пользователей. Установка
Выполнить команду
php composer require komer45/yii2-balance "*"
Или добавить в composer.json
"komer45/yii2-balance": "*",
И выполнить
php composer update
Далее, мигрируем базу:
php yii migrate --migrationPath=vendor/komer45/yii2-balance/migrations
Подключение и настройка
Для пользования необходимо подключить модуль в конфиге:
'modules' => [
'balance' => [
'class' => 'komer45\balance\Module',
'adminRoles' => ['superadmin', 'administrator'],
'otherRoles' => ['manager', 'user'],
'currencyName' => 'баллов'
],
...
]
Для доступа к компоненту (в данном модуле - для совершения) в том же конфиге необходимо подключить обращение:
'components' => [
...
'balance' => [
'class' => 'komer45\balance\Balance'
],
...
]
Если данный модуль предполагается использовать совместно с модулем yii2-partnership, то в конфиге к модулю partnership необходимо подписаться на событие совершения операции перевода данного модуля:
'partnership' => [ 'class' => 'komer45\partnership\Module', 'layout' => 'main', 'adminRoles' => ['superadmin', 'administrator'], 'on makePayment' => function($event){ $model = $event->model; $userId = Yii::$app->Partnership->getUserByPartnerId($model->partner_id); $balance = Yii::$app->balance->getUserScore($userId); Yii::$app->balance->addTransaction($balance->id, 'in', $model->sum, 'partnership rewads'); } ],
Для того, чтобы кошелек автоматически создавался для пользователя нужно модифицировать стандартную модель 'User'(commmon\models\User) следующим образом:
...
use komer45\balance\models\Score;
...
public function afterSave($p1, $p2)
{
$findUser = Score::find()->where(['user_id' => $this->getId()])->one();
if (!$findUser){
$userBalance = new Score;
$userBalance->user_id = $this->getId();
$userBalance->balance = 0;
if($userBalance->validate()){
return $userBalance->save();
} else die('Uh-oh, somethings went wrong!');
}
}
В этой же модели (ниже) необходимо добавить метод getScore, который отвечает за получение текущего остатка пользователя:
public function getScore($userId = null)
{
if ($userId){
return $userScore = Score::find()->where(['user_id' => $userId])->one()->balance;
}
return $userScore = Score::find()->where(['user_id' => Yii::$app->user->id])->one()->balance;
}
Если модель подключаемого User не соответствует 'common\models\User' то ее необходимо задать в Модуле(Module.php) изменив переменную $userModule; Для облегчения переходов и информатирования пользователя о количестве баланса предусмотренны следующие виджеты:
<?php
use komer45\balance\widgets\BalanceWidget; //Виджет для вывода пользователю его баланса со ссылкой на историю его транзакций
use komer45\balance\widgets\ScoreButtonWidget; //Виджет для перехода на страницу кошельков
use komer45\balance\widgets\TransactionButtonWidget; //Виджет для перехода на страницу транзакций
...
echo BalanceWidget::widget();
echo ScoreButtonWidget::widget();
echo TransactionButtonWidget::widget();
?>