PHPackages                             edulazaro/larawards - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. edulazaro/larawards

ActiveLibrary[Utility & Helpers](/categories/utility)

edulazaro/larawards
===================

A rewards system for Laravel, allowing to create rewards like achievements or trophies.

1.0.9(2y ago)210PHPPHP >=8.1

Since Oct 7Pushed 2y ago1 watchersCompare

[ Source](https://github.com/edulazaro/larawards)[ Packagist](https://packagist.org/packages/edulazaro/larawards)[ RSS](/packages/edulazaro-larawards/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (1)Versions (10)Used By (0)

Larawards
=========

[](#larawards)

An way of implementing achievement on Laravel.

How to install Larawards
------------------------

[](#how-to-install-larawards)

Execute this command on the Laravel root project folder:

```
composer require edulazaro/larawards
```

Configure the database details on the `.env` file and execute the migrations using:

```
php artisan migrate
```

Creating new awards
-------------------

[](#creating-new-awards)

To create a new award (achievement, trophy, badge...) use this command, replacing `FooAchievement` for the ward class name:

```
php artisan make:award FooAchievement
```

This will create a new award on the `app/Awards/FooAchievement.php`.

An award can be of different types, like an `achievement` or a `badge`. To set the type, use thje `$type` attribute:

```
/** @var string The award type. */
public $type = 'achievement';
```

An award can have one or more tiers. Each tier si something which can be awarded, like an achievement. Tiers allow to define similar achievements on a single file:

```
/** @var protected The award tiers. */
protected array $tiers = [
    'comment_written' => [
        'score' => 1,
        'title' => 'First Comment Written',
    ],
    '3_comments_written' => [
        'score' => 3,
        'title' => '3 Comments Written',
    ],
    '5_comments_written' => [
        'score' => 5,
        'title' => '5 Comments Written',
    ],
    '10_comments_written' => [
        'score' => 10,
        'title' => '10 Comments Written',
    ],
    '20_comments_written' => [
        'score' => 20,
        'title' => '20 Comments Written',
    ],
];
```

Each tier has a `title`, which is the achievement/badge name and also a `score`,` which is the score needed to reward the users with the achievement/badge.

Finally, the `score` method is the place to code the logic which retrieves the current award score for the `awardablep` user:

```
/**
* Get the awardable score a user
 *
* @return int
*/
public function score(): int
{
    return $this->rewardable->comments()->count();
}
```

Registering awards
------------------

[](#registering-awards)

If you ant an model to accept rewards, you will need to use the `HasWards` trait into it, like on this example:

```
namespace App\Models;

use EduLazaro\Larawards\Concerns\HasRewards;

class User
{
    use HasRewards;

}
```

The achievements should be registered with the User model or another model including the `HasRewards` trait using the `AwardProvider`:

```
User::awardable(AchievementsBadge::class);
```

Or grouped:

```
User::awardableGroup('achievements', [
    CommentsAchievement::class,
    LessonsWatchedAchievement::class
]);
```

Awards can be registed to any model which uses the `HasRewards` trait.

Checking rewards
----------------

[](#checking-rewards)

When you need to check an award, you can do this:

```
FooAchievement::scope($user)->check();
```

As you can see, the award needs to be scoped first to the user This will add the reward if it matches the requirement of any tier. awardables.

You can also perform queries to check many awards at a time. This will check all awards assigned to a user:

```
User::awardables()->check();
```

You can also select a specific group:

```
User::awardables()->group('top_awards')->check();
```

Or a specific type:

```
User::awardables()->where('type', 'achievement')->check();
```

Once an award is awarded, it will be added into the `rewards` table.

Reward events
-------------

[](#reward-events)

If you want, you can specify an event to be fired using the `$event` attribute:

```
namespace App\Awards;

use EduLazaro\Larawards\Concerns\IsAward;
use EduLazaro\Larawards\Contracts\AwardInterface;
use App\Events\AchievementUnlocked;

class CommentsAchievement implements AwardInterface
{
    use IsAward;

    // ...

    protected string $event = AchievementUnlocked::class;
    // ...
}
```

This event will be fired each time a user gets a reward.

Checking awards
---------------

[](#checking-awards)

To get the rewards for a user you can do:

```
$rewards = $user->rewards;
```

To check if a specific award and tier has been rewarded:

```
$isRewarded = $user->rewards()->where('name', 'comment_written')->exists();
```

You can query the rewards for many users:

```
use EduLazaro\Larawards\Models\Reward;

// ...
Reward::where('award_id', 'comments_achievement')->get();
```

Awards morph map
----------------

[](#awards-morph-map)

This works in the same way as the standard [Laravel morph maps](https://laravel.com/docs/10.x/eloquent-relationships#custom-polymorphic-types).

When a reward is inserte dinto the database, the award id will be the class where the award is defined. However this looks ugly. To fix it, use the `Award::enforceMap` method on any service provider:

```
namespace App\Providers;

use Illuminate\Support\ServiceProvider;
use EduLazaro\Larawards\Collections\Awards;

use App\Awards\CommentsAchievement;
use App\Awards\LikesAchievement;

class AwardServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        Awards::enforceMap([
            'comments_achievement' => CommentsAchievement::class,
            'likes_achievement' => LikesAchievement::class,
        ]);
    }
}
```

This will assign the specified alias to the desided Award classes. For example, the `App\Awards\CommentsAchievement` will be represented as `comments_achievement` which is more readable.

License
-------

[](#license)

The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).

###  Health Score

26

—

LowBetter than 43% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~16 days

Recently: every ~0 days

Total

9

Last Release

817d ago

PHP version history (2 changes)1.0.0PHP ^8.1

1.0.2PHP >=8.1

### Community

Maintainers

![](https://www.gravatar.com/avatar/6a3c47449dfb2ec121aa410da024f47586b87cc2799a825f0418e6c5e5904955?d=identicon)[edulazaro](/maintainers/edulazaro)

---

Top Contributors

[![edulazaro](https://avatars.githubusercontent.com/u/7797530?v=4)](https://github.com/edulazaro "edulazaro (13 commits)")

### Embed Badge

![Health badge](/badges/edulazaro-larawards/health.svg)

```
[![Health](https://phpackages.com/badges/edulazaro-larawards/health.svg)](https://phpackages.com/packages/edulazaro-larawards)
```

###  Alternatives

[tightenco/ziggy

Use your Laravel named routes in JavaScript.

4.3k41.6M267](/packages/tightenco-ziggy)[wireui/wireui

TallStack components

1.8k1.3M16](/packages/wireui-wireui)[ramonrietdijk/livewire-tables

Dynamic tables for models with Laravel Livewire

21147.4k](/packages/ramonrietdijk-livewire-tables)[nickurt/laravel-akismet

Akismet for Laravel 11.x/12.x/13.x

97139.6k2](/packages/nickurt-laravel-akismet)[sbine/route-viewer

A Laravel Nova tool to view your registered routes.

57215.9k](/packages/sbine-route-viewer)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)