Creditable models

Implement the Creditable interface and use the HasCredits trait on any Eloquent model. The trait provides every method the interface declares:

use Illuminate\Database\Eloquent\Model;
use RoundlyConsulting\Credits\Interfaces\Creditable;
use RoundlyConsulting\Credits\Traits\HasCredits;

final class User extends Model implements Creditable
{
    use HasCredits;
}

Implement the interface — don’t skip it. Every API takes the owner as a Model&Creditable, so a model that only uses the trait fails with a TypeError on its first credits call (static analysis flags it before that), and credits:modify skips any entity that is not Creditable.

Any model, not just users

Credits attach polymorphically, so teams, organisations, projects or devices can each hold their own balance in the same table:

final class Team extends Model implements Creditable
{
    use HasCredits;
}

Credits::for($team)->add(5000, 'prepaid API calls');
Credits::for($team)->balance();         // 5000
$team->creditsBalance();                // 5000 — the same read through the trait

What the trait adds

Every read and write accepts an optional bucket; omit it and the configured default_bucket is used. Every read accepts an optional point in time ($at, any CarbonInterface). Each method is shorthand for the same call through Credits::for($this) — see The Credits facade.