Level-Up is a Laravel package introducing gamification into your applications. Users earn experience points (XP) and levels through interactions, while also unlocking achievements. It promotes engagement, competition, and fun through its dynamic leaderboard feature. Customisable to fit your specific needs
License: MIT License
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "github-actions[bot]")
Originally posted by matthewscalf July 21, 2023
When utilizing this package, the Achievements are cool idea but the migrations and Pivot models assume you have named the User model users. But you have the option to customize that for the other functions. Would be good to see the achievements utilize the same level of customization.
Add the config option for the User model in more places
Just trying to do first migration and had a issue with streak_history_table.
I changed the migration table as a placebo, but since i just did it, no idea if will face bugs because of that, so just sharing.
$table->id();
$table->foreignId(column: config(key: 'level-up.user.foreign_key'))->constrained(table: config(key: 'level-up.user.users_table'))->cascadeOnDelete();
$table->foreignIdFor(model: Activity::class)->constrained(table: 'streak_activities');
$table->integer(column: 'count')->default(value: 1);
$table->timestamp(column: 'started_at')**->nullable(**);
$table->timestamp(column: 'ended_at'**)->nullable()**;
$table->timestamps();
`PS C:\Users\tatia\Dropbox\Coding\Laravel\l96lab> php artisan migrate
INFO Running migrations.
2023_10_31_000158_create_streak_histories_table ...................................................... 11ms FAIL
Illuminate\Database\QueryException
SQLSTATE[42000]: Syntax error or access violation: 1067 Invalid default value for 'ended_at' (Connection: mysql, SQL: create table streak_histories (id bigint unsigned not null auto_increment primary key, user_id bigint unsigned not null, activity_id bigint unsigned not null, count int not null default '1', started_at timestamp not null, ended_at timestamp not null, created_at timestamp null, updated_at timestamp null) default character set utf8mb4 collate 'utf8mb4_unicode_ci')
at vendor\laravel\framework\src\Illuminate\Database\Connection.php:801
797▕ $this->getName(), $query, $this->prepareBindings($bindings), $e
798▕ );
799▕ }
800▕
➜ 801▕ throw new QueryException(
802▕ $this->getName(), $query, $this->prepareBindings($bindings), $e
803▕ );
804▕ }
805▕ }
1 vendor\laravel\framework\src\Illuminate\Database\Connection.php:580
PDOException::("SQLSTATE[42000]: Syntax error or access violation: 1067 Invalid default value for 'ended_at'")
2 vendor\laravel\framework\src\Illuminate\Database\Connection.php:580
PDOStatement::execute()
`
Only did a migration on my actual project and had this error.
1.1
8.2
10
No response
I made a pull request if that solution make sense. Ignore if dont.
Originally posted by Temian1 July 20, 2023
i tried to give user point and i got that issue
p\project\trendup\app\Multipliers" directory does not exist.
```</div>
Hey mate when I try to utilise $user->nextLevelAt(); it only ever returns 0 and when I add points to the user in question, it increments the level regardless of what the next_level_experience column has stored.
Seed the levels, add points to a user account and use the getLevel(), nextLevelAt() and getPoints() helper functions.
^0.0.6
8.1
10
macOS
I think you just change the nextLevelAt() function in the trait to be:
$nextLevel = Level::firstWhere(column: 'level', operator: '=', value: is_null($checkAgainst) ? $this->getLevel() + 1 : $checkAgainst);
and it will work again. The check using ?? that is originally there passes null to the level where check and is breaking because it's checking for a null "level" column instead of a null "next_level_experience" column as intended.
I was testing streak continuation this morning and have found that the check at HasStreaks:51 for strict equality $diffInDays === 1.
If you see the screenshot attached you'll see that even though $diffInDays shows as 1, this evaluates to false. This is because $diffInDays is a float.
Try with Laravel 11 / Carbon 3.
1.2
8.2
11.0
Windows
After a quick search I found this article, breaking change in Carbon 3.0 is that these will be returned as floats now.
I cloned this repo and ran the test suite on a fresh install and can confirm that your tests are also failing on this.
Thank you for this library!
First thing, I love this repo. Great job!
$user->addPoints(
amount: 50,
multiplier: 2,
type: AuditType::Add->value,
reason: "Some reason here",
);
Adds the amount and multiplier, but doesn't trigger the AuditType and reason.
$user->addPoints(
amount: 50,
multiplier: 2,
type: AuditType::Add->value,
reason: "Some reason here",
);
0.0.6
8.2
10.x
macOS
No response
Hello
I was messing around with your package and noticed very bad bug.
When points earned by user are enough to gain more than one level it gets increased only by one closest to level user currently has.
When next points are awarded next level is unlocked but it should be done in one run in my opinion as there may be along time before user earns next points and he will be stuck at lower level making functions like:
$user->nextLevelAt();
useless as they will display 0 as points requirements for next level are already met.
Is there any way to award multiple levels at one points increase operation?
Level::add(
['level' => 1, 'next_level_experience' => null],
['level' => 2, 'next_level_experience' => 100],
['level' => 3, 'next_level_experience' => 250],
);
$user->addPoints(300);
$user->addPoints(1);
v0.0.10
8.1
10.2
Windows
No response
User's level is not changing when the points are reduced.
When a user gains certain amount of points the level changes and he will get to a higher level.
However if I deduct points for this user , his experience changes but his level stays the same even tho now it should be lower.
Add points to a user until he reaches a certain level. Then try to deduct his points. The experience will change however the level will stay the same
2
8.2.0
9.0.0
macOS, Linux
No response
Illuminate\Database\QueryException
SQLSTATE[42000]: Syntax error or access violation: 1067 Invalid default value
for 'ended_at' (Connection: mysql, SQL: create table streak_histories (id bi
gint unsigned not null auto_increment primary key, user_id bigint unsigned not
null, activity_id bigint unsigned not null, count int not null default '1',
started_at timestamp not null, ended_at timestamp not null, created_at ti
mestamp null, updated_at timestamp null) default character set utf8mb4 collate
'utf8mb4_unicode_ci')
i try to do fresh migrate
2
8
10
Windows
No response
If there is no experience record yet and you run getPoints() it returns the following:
App\Models\User::getPoints(): Return value must be of type int, null returned
try to run getPoints() while there are no points
1.1.0
8.2.14
10.41
Linux
Fix could be:
public function getPoints(): int
{
return $this->experience->experience_points ?? 0;
}Where it will always return 0 if there are no XP points yet.
If you are fine with it I can shoot a PR including a test
When i add the points needed to level up to the next level i get this.
$amount = 200;
$Pointsamount = 400;
$user->coins += $amount;
$user->addPoints($Pointsamount);
^1.2.3
8.2.7
^10.0
Linux
No response
I am trying to integrate this package with my application.
However I am not able to pass through registering an user as package causes an error:
[2023-08-24 01:23:49] local.ERROR: Attempt to read property "status" on null {"userId":1,"exception":"[object] (ErrorException(code: 0): Attempt to read property "status" on null at C:\Users\username\Desktop\application_name\script\vendor\cjmellor\level-up\src\Concerns\GiveExperience.php:103)
I have added GiveExperience trait to Used model as instructed.
I have added custom name and reward columns into levels table.
I have seeded test levels:
$levelsArray = [
[
'name' => 'Rookie',
'required_turnover' => null,
'reward' => null
],
[
'name' => 'Seeker',
'required_turnover' => '200000',
'reward' => '5000'
],
];
foreach ($levelsArray as $index => $level) {
$levelRecord = new Level();
$levelRecord->name = $level['name'];
$levelRecord->level = $index+1;
$levelRecord->next_level_experience = $level['required_turnover'];
$levelRecord->reward = $level['reward'];
$levelRecord->save();
}
Then I am trying to seed first user
$user = new User();
$user->username = config('administrator.username');
$user->email = config('administrator.email');
$user->password = config('administrator.password');
$user->status = UserStatus::active;
$user->level_id = 1;
$user->save();
$user->addPoints(amount: 1);
$userService = new UserService();
$userService->createRequiredUsersTables($user->id);
And script is killed with error I have posted above.
What is causing this issue?
Same error happens when I add levels using package provided Level model method on "stock" table.
^0.0.6
8.1
10.2
Windows
No response
Reaching max level and calling nextLevelAt function throws error Attempt to read property "next_level_experience" on null
I created 4 levels:
Level::add(
['level' => 1, 'next_level_experience' => null],
['level' => 2, 'next_level_experience' => 100],
['level' => 3, 'next_level_experience' => 250],
['level' => 4, 'next_level_experience' => 500],
);implement a route where I do this:
$user = \App\Models\User::find(1);
$user->addPoints(50);
echo $user->getLevel();
echo $user->getPoints();
echo $user->nextLevelAt();Run api calls to the route repeatedly
When the user reaches the maximum level, call the function nextLevelAt
Environment Variables
LEVEL_CAP_ENABLED=true
LEVEL_CAP=4
LEVEL_CAP_POINTS_CONTINUE=true
AUDIT_POINTS=true
0.0.5
8.2.8
10.10
macOS
The error seems to be on line 152 of the vendor/cjmellor/level-up/src/Concerns/GiveExperience.php file when trying to look for a level higher than 4 which is the maximum set in my environment variables.
Could it be that I am missing some configuration?
I am using:
The LeaderboardService.php has a hard-coded dependency on there being a users table, ignoring the configuration file with ->whereColumn('user_id', 'users.id').
<?php
namespace LevelUp\Experience\Services;
use Illuminate\Contracts\Pagination\LengthAwarePaginator;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Collection;
use LevelUp\Experience\Models\Experience;
class LeaderboardService
{
private mixed $userModel;
public function __construct()
{
$this->userModel = config(key: 'level-up.user.model');
}
public function generate(bool $paginate = false, int $limit = null): array|Collection|LengthAwarePaginator
{
return $this->userModel::query()
->with(relations: ['experience', 'level'])
->orderByDesc(
column: Experience::select('experience_points')
->whereColumn('user_id', 'users.id')
->latest()
)
->take($limit)
->when($paginate, fn (Builder $query) => $query->paginate(), fn (Builder $query) => $query->get());
}
}
Use a table that isn't named 'users'.
latest
8.2.11
10
No response
Two database migrations also have hardcoded references to users, while the rest read from the config.
When creating 3 levels as the documentation indicates, I carried out tests loading 50 points in my user repeatedly and although the points reached 100 to go to level 2, this never happened.
When implementing the AUDIT_POINTS=true option I could notice as if the attempt to level up was marked but my experience record remained at 1 even though my points were 250
I created 3 levels as the documentation indicates:
Level::add(
['level' => 1, 'next_level_experience' => null],
['level' => 2, 'next_level_experience' => 100],
['level' => 3, 'next_level_experience' => 250],
);implement a route where I do this:
$user = \App\Models\User::find(1);
$user->addPoints(50);
echo $user->getLevel();
echo $user->getPoints();Run api calls to the route repeatedly
Environment Variables
LEVEL_CAP_ENABLED=true
LEVEL_CAP=3
LEVEL_CAP_POINTS_CONTINUE=true
AUDIT_POINTS=true
0.0.4
8.2.8
10.10
macOS
When I ran into this error, I did some tests on the package code and realized that I wasn't updating my experience level record but my points were.
While debugging, I changed in the vendor/cjmellor/level-up/src/Concerns/GiveExperience.php file the line 160 in the levelUp method of and was able to solve my problem:
Before:
$this->experience->status()->associate(model: $nextLevel);After:
$this->experience->status()->associate(model: $nextLevel)->save();Could you tell me if I'm doing something wrong?
I am using:
I've noticed that the package has a listener for the PointsIncreased event (PointsIncreasedListener.php), but there is no dedicated listener for the PointsDecreased event.
Additionally, while the database migration for experience audits (create_experience_audits_table.php.stub) has a column for type that can be 'add', 'remove', 'reset', or 'level_up', it seems that the decrement case is not explicitly stored in the database through a listener.
This could be an important feature for tracking user activities related to points decrement.
Would it be possible to add a listener for the PointsDecreased event and store this information in the database?
When I deductPoints the decrement case is not explicitly stored in the database through a listener.
0.0.13
8.2.0
10.0.0
No response
No response
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
Django
The Web framework for perfectionists with deadlines.
Laravel
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft
Open source projects and samples from Microsoft.
Google
Google ❤️ Open Source for everyone.
Alibaba
Alibaba Open Source for everyone
D3
Data-Driven Documents codes.
Tencent
China tencent open source team.