Download the PHP package centrex/laravel-wallet without Composer
On this page you can find all versions of the php package centrex/laravel-wallet. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download centrex/laravel-wallet
More information about centrex/laravel-wallet
Files in centrex/laravel-wallet
Package laravel-wallet
Short Description Add wallet functionality in laravel application
License MIT
Homepage https://github.com/centrex/laravel-wallet
Informations about the package laravel-wallet
Add wallet functionality in laravel application
Easily add a virtual wallet to your Laravel models. Features multiple wallets and a ledger system to help keep track of all transactions in the wallets.
Contents
- Installation
- Usage Examples
- Testing
- Changelog
- Contributing
- Credits
- License
Installation
You can install the package via composer:
You can publish the config file with:
This is the contents of the published config file:
Optionally, you can publish the views using
Usage
First, you'll need to add the HasWallets
trait to your model.
By adding the HasWallets
trait, you've essentially added all the wallet relationships to the model.
You can start by creating a wallet for the given model.
You can then increment the wallet balance by:
Or decrement the balance by:
To get the balance of the wallet, you can use the balance
accessor:
A wallet can be accessed using the wallet()
method in the model:
You can set up multiple types of wallets by defining a WalletType
. Simply create a wallet type entry in the
wallet_types
table and create a wallet using this wallet type.
You can access a model's particular wallet type by using the wallet()
method as well:
All movements made in the wallet are recorded in the wallet_ledgers
table.
Defining Transactions
Ideally, we want to record all transactions concerning the wallet by linking it to a transaction model. Let's say we
have a PurchaseTransaction
model which holds the data of a purchase the user makes in our app.
We can link this PurchaseTransaction
to the wallet ledger by implementing the WalletTransaction
contract to this
model and using this transaction to decrement (or increment, whatever the case may be) the wallet balance.
Now we can use this in the wallet:
By doing this, you will be able to see in the wallet_ledgers
table the transaction that is related to the movement
in the wallet.
Testing
๐งน Keep a modern codebase with Pint:
โ Run refactors using Rector
โ๏ธ Run static analysis using PHPStan:
โ Run unit tests using PEST
๐ Run the entire test suite:
Changelog
Please see CHANGELOG for more information on what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Credits
- centrex
- All Contributors
- CoreProc/laravel-wallet-plus
License
The MIT License (MIT). Please see License File for more information.
All versions of laravel-wallet with dependencies
illuminate/database Version ^10.0|^11.0|^12.0
illuminate/support Version ^10.0|^11.0|^12.0