depsimon/laravel-wallet

Easy to use virtual wallet for your app

Laravel Wallet

In a few projects I had to implement a virtual currency. The user would buy packs of credits with Stripe and then use them in the app in exchange of services or goods. This package is a small and simple implementation of this concept with place for customization., _(*1)

Installation

Install the package with composer:, _(*2)

composer require depsimon/laravel-wallet

Run Migrations

Publish the migrations with this artisan command:, _(*3)

php artisan vendor:publish --provider="Depsimon\Wallet\WalletServiceProvider" --tag=migrations

Configuration

You can publish the config file with this artisan command:, _(*4)

php artisan vendor:publish --provider="Depsimon\Wallet\WalletServiceProvider" --tag=config

This will merge the wallet.php config file where you can specify the Users, Wallets & Transactions classes if you have custom ones., _(*5)

Usage

Add the HasWallet trait to your User model., _(*6)

``` php, <sub>(*7)</sub>

use Depsimon\Wallet\HasWallet;, <sub>(*8)</sub>

class User extends Model { use HasWallet;, <sub>(*9)</sub>

...

}, <sub>(*10)</sub>

At some point before making transactions, create the user's wallet.

```php
$user->wallet()->create();

Then you can easily make transactions from your user model., <sub>(*11)</sub>

``` php $user = User::find(1); $user->balance; // 0, <sub>(*12)</sub>

$user->deposit(100); $user->balance; // 100, <sub>(*13)</sub>

$user->withdraw(50); $user->balance; // 50, <sub>(*14)</sub>

$user->forceWithdraw(200); $user->balance; // -150, <sub>(*15)</sub>

You can easily add meta information to the transactions to suit your needs.

``` php
$user = User::find(1);
$user->deposit(100, 'deposit', ['stripe_source' => 'ch_BEV2Iih1yzbf4G3HNsfOQ07h', 'description' => 'Deposit of 100 credits from Stripe Payment']);
$user->withdraw(10, 'withdraw', ['description' => 'Purchase of Item #1234']);

Security

If you discover any security related issues, please email simon@webartisan.be instead of using the issue tracker., <sub>(*16)</sub>

Credits

• Simon Depelchin

License

The MIT License (MIT). Please see License File for more information., <sub>(*17)</sub>