A ledger-based Laravel package for managing credit-based systems in your application. Perfect for virtual currencies, reward points, or any credit-based feature.
- 🔄 Credit transactions
- 💸 Credit transfers
- 📢 Events for adding, deducting, and transferring credits
- 💰 Balance tracking with running balance
- 📊 Transaction history
- 🔍 Point-in-time balance lookup
- 📝 Transaction metadata support
- ⚡ Efficient queries using running balance and indexes
You can install the package via composer:
composer require climactic/laravel-creditsPublish and run the migrations:
php artisan vendor:publish --tag="credits-migrations"
php artisan migrateOptionally publish the config file:
php artisan vendor:publish --tag="credits-config"return [
// Allow negative balances
'allow_negative_balance' => false,
// Table name for credit transactions (change if you've updated the migration table name)
'table_name' => 'credits',
];Add the HasCredits trait to any model that should handle credits:
use Climactic\Credits\Traits\HasCredits;
class User extends Model
{
use HasCredits;
}// Add credits
$user->addCredits(100.00, 'Subscription Activated');
// Deduct credits
$user->deductCredits(50.00, 'Purchase Made');
// Get current balance
$balance = $user->getCurrentBalance();
// Check if user has enough credits
if ($user->hasEnoughCredits(30.00)) {
// Proceed with transaction
}Transfer credits between two models:
$sender->transferCredits($recipient, 100.00, 'Paying to user for their service');// Get last 10 transactions
$history = $user->getTransactionHistory();
// Get last 20 transactions in ascending order
$history = $user->getTransactionHistory(20, 'asc');Get balance as of a specific date:
$date = new DateTime('2023-01-01');
$balanceAsOf = $user->getBalanceAsOf($date);Add additional information to transactions:
$metadata = [
'order_id' => 123,
'product' => 'Premium Subscription'
];
$user->addCredits(100.00, 'Purchase', $metadata);Events are fired for each credit transaction, transfer, and balance update.
The events are:
CreditsAddedCreditsDeductedCreditsTransferred
composer testPlease see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
Please report security vulnerabilities to [email protected].
GitHub Sponsors: @climactic
To become a title sponsor, please contact [email protected].
The MIT License (MIT). Please see License File for more information.
This package is not affiliated with Laravel. It's for Laravel but is not by Laravel. Laravel is a trademark of Taylor Otwell.
