wallet

Wallet allows you to maintain credits for your users., _(*1)

Installation

To install the package, include the following in your composer.json., _(*2)

"owlgrin/wallet": "dev-master"

And then include the following service provider in your app.php., _(*3)

'Owlgrin\Wallet\WalletServiceProvider'

And lastly, publish the config., _(*4)

php artisan config:publish owlgrin/wallet

Usage

Write this command in your artisan to create migrations, _(*5)

php artisan wallet:table

Now migrate all the tables to your mysql db, _(*6)

php artisan migrate

You can initiate wallet by writing, _(*7)

Wallet::user($userId)

where $userId is the unique id of your user, _(*8)

Credits, _(*9)

You can add credits of your user, _(*10)

Wallet::credits($credits, $redemptions)

where $credits is the amount of credits you want to add for your user and $redemptions is number of times you want your user to use these credits, _(*11)

Redemptions, _(*12)

You can redeem the credits by using, _(*13)

Wallet::redeem($amount)

where $amount is the requested amount on which you want to access the credit, _(*14)

Left Credits, _(*15)

You can see the left credits by using, _(*16)

Wallet::left();

Exceptions, _(*17)

Wallet comes with custom exceptions, to make them easier to handle. These are the followin custom exceptions that you can use:, _(*18)

Owlgrin\Wallet\Exceptions\CreditsLimitReachedException;
Owlgrin\Wallet\Exceptions\NoCreditsException;
Owlgrin\Wallet\Exceptions\InternalException;

Each of these extend an abstract class Owlgrin\Wallet\Exceptions\Exception., _(*19)

You can use it like following:, _(*20)


try
{
    Wallet::Redeem(5445);
}
catch(Owlgrin\Wallet\Exceptions\NoCreditsException $e)
{
    return $e;
}
catch(Owlgrin\Wallet\Exceptions $e)
{
    return $e;
}