Weave Code
Laravel Badges Laravel Package
maize-tech/laravel-badges
Laravel Badges lets you attach badges and achievements to any Eloquent model via a simple trait. Define badges, assign or revoke them, check ownership, and build gamification features like user rewards with a clean, fluent API.
This package lets you easily add badge mechanics to your application
Frequently asked questions about Laravel Badges
- How do I install maize-tech/laravel-badges in a Laravel application?
- Install it as a Composer dependency in your Laravel project, then follow the package's normal Laravel setup steps such as publishing config or migrations if required. Because it uses standard Laravel package conventions, service-provider discovery should handle most wiring. Run migrations in a clean environment and execute your test suite before deploying.
- Does maize-tech/laravel-badges support Laravel 12?
- Yes, release 1.2.0 adds Laravel 12 support. The release notes do not call out breaking changes, but you should still confirm the exact PHP and Laravel constraints in composer.json. Validate the package in a branch before upgrading your framework in production.
- How do I attach badges to an Eloquent model with laravel-badges?
- Add the package's badge trait to any Eloquent model that should support badges, then use the fluent badge API to define, assign, or revoke badges. This lets you apply badges to users or other domain models without building the badge relationship logic yourself. Keep assignment calls behind your application services or events to reduce coupling.
- Can I assign and revoke badges for users in Laravel?
- Yes, the package is designed for attaching badges and achievements to Eloquent models and supports assigning or revoking them. For user rewards, add the trait to your User model and call the badge API from your application service or event handler. Consider transaction boundaries and indexes if badge writes happen at high volume.
- How do I check whether a model owns a badge?
- The package provides ownership checks through its fluent API after the badge trait is added to the model. Use those checks in controllers, policies, or domain services instead of querying package tables directly. This keeps badge logic encapsulated and makes future package upgrades easier.
- Do I need to publish migrations or config for laravel-badges?
- The package follows Laravel service-provider, config, and migration conventions, so setup may include publishing its config or migrations depending on your installation. Review the package defaults and compare them with any existing published files before upgrading. Run migration rollback checks in a clean environment to catch conflicts.
- Is upgrading from laravel-badges 1.1.0 to 1.2.0 safe?
- The 1.2.0 release adds Laravel 12 support, includes PHPStan fixes, and bumps a CI action, with no breaking changes or deprecations called out in the release notes. The notes are sparse, so review the 1.1.0 to 1.2.0 diff, composer constraints, and CI status before upgrading. Test in a branch and keep rollback to 1.1.0 available.
- How should I test badge assignment in a Laravel app?
- Exercise badge assignment and revocation through your application services or model trait in unit and integration tests. Include checks for ownership, duplicate assignment behavior, migration rollback, and any events or queues involved. Run the full app test suite on the target PHP and Laravel version before release.
- Can laravel-badges be used for gamification and achievements?
- Yes, the package is intended for badge mechanics and supports gamification features such as user rewards and achievements. It handles badge definition, assignment, revocation, and ownership checks so you do not have to build that domain logic from scratch. Treat badges as a supporting capability and keep reward rules in your own application layer.
- What are the production risks of using laravel-badges?
- Risks are low to moderate: Composer dependency-resolution failures, migration conflicts, config drift, and Laravel 12 edge incompatibilities are the main concerns. Badge assignment writes can add database load if used at high volume, so review indexes, transactions, and async processing. Assign an internal owner, document badge lifecycle, and test rollback before broad rollout.
Weaver
How can I help you explore Laravel packages today?