Configuration

The package ships with sensible defaults and works with zero host configuration. The published config/credits.php in full:

<?php

declare(strict_types=1);

use RoundlyConsulting\Credits\Models\Credit;

return [

    'model' => Credit::class,

    'key_type' => env('CREDITS_KEY_TYPE', 'bigint'),

    'primary_key_type' => env('CREDITS_PRIMARY_KEY_TYPE', 'bigint'),

    'allow_overdraft' => env('CREDITS_ALLOW_OVERDRAFT', false),

    'minimum_balance' => 0,

    'default_bucket' => 'default',

    'scale' => 0,

    'rounding' => env('CREDITS_ROUNDING', 'half_away_from_zero'),

    'currencies' => [
        // 'store_credit' => 'EUR',
        // 'points' => 'PTS',
    ],

    'modifiable' => [
        //
    ],

];

Every key

Environment

The deployment-sensitive keys are env-backed:

CREDITS_KEY_TYPE=bigint
CREDITS_PRIMARY_KEY_TYPE=bigint
CREDITS_ALLOW_OVERDRAFT=false
CREDITS_ROUNDING=half_away_from_zero

Things to decide early

• key_type and primary_key_type are read when the migration runs — choose them before you publish and migrate. Changing either afterwards is a data migration, not a config change.
• An unrecognized key type throws InvalidConfigurationException naming the key — it never falls back to bigint.
• Every other setting is read strictly too: a key that is not set — absent, null or blank (a host’s KEY=) — takes its default, and a present value of the wrong shape — fifty for the floor, an array for the bucket, a string where the resolver list belongs — throws InvalidConfigurationException naming the key. A typo is never cast to 0 or swapped for the default.
• credits.currencies is resolved lazily on every use, never at boot, so a custom currency registered in your own provider’s boot() is accepted.
• credits.rounding must name a \RoundingMode case in snake_case; the legacy PHP_ROUND_* integers are refused.
• CREDITS_ALLOW_OVERDRAFT is read as a boolean — off, no and false really leave overdraft off, and php artisan about reports exactly what the guard enforces.