binafy / laravel-score
Give score to all things
Requires
- php: ^8.0
- laravel/framework: ^9.0|^10.0|^11.0
Requires (Dev)
- orchestra/testbench: ^7.0|^8.0|^9.0
- pestphp/pest-plugin-laravel: ^1.4.0|^2.0.0
README
Introduction
A comprehensive Laravel package to implement scoring systems effortlessly. Whether you're building leaderboards, calculating performance metrics, or managing gamification features, Laravel Score provides an intuitive API to define, calculate, and manage scores seamlessly. Perfect for applications requiring dynamic and flexible scoring mechanisms.
Key Features:
- Simple integration with Eloquent models.
- Support for customizable scoring rules.
- Designed for performance and scalability.
- Extensible and developer-friendly.
Installation
You can install the package with Composer.
composer require binafy/laravel-score
Publish
If you want to publish a config file you can use this command:
php artisan vendor:publish --tag="laravel-score-config"
If you want to publish the migrations you can use this command:
php artisan vendor:publish --tag="laravel-score-migrations"
For convenience, you can use this command to publish config, migration, and ... files:
php artisan vendor:publish --provider="Binafy\LaravelScore\Providers\LaravelScoreServiceProvider"
After publishing, run the php artisan migrate
command.
Usage
First of all, you need to use two traits:
use Binafy\LaravelScore\Traits\InteractWithScore; use \Illuminate\Database\Eloquent\Model; class User extends Model { use InteractWithScore; }
And your model that want to give score to it:
use Binafy\LaravelScore\Traits\Scoreable; use Illuminate\Database\Eloquent\Model; class Photo extends Model { use Scoreable; }
Add Score
For giving a score to scoreable, you can use addScore()
method:
$user->addScore( Model $scoreable, int $score = 1, int|null $userId = null );
Add Negative Score
If you want to add negative score to scoreable, you can use addNegativeScore()
method:
$user->addNegativeScore( Model $scoreable, int|null $userId = null );
Contributors
Thanks to all the people who contributed. Contributors.
Security
If you discover any security-related issues, please email binafy23@gmail.com
instead of using the issue tracker.
Changelog
The changelog can be found in the CHANGELOG.md
file of the GitHub repository. It lists the changes, bug fixes, and improvements made to each version of the Laravel User Monitoring package.
License
The MIT License (MIT). Please see License File for more information.
Star History
Donate
If this package is helpful for you, you can buy a coffee for me :) ❤️
- Iranian Gateway: https://daramet.com/milwad_khosravi
- Paypal Gateway: SOON
- MetaMask Address:
0xf208a562c5a93DEf8450b656c3dbc1d0a53BDE58