Configuration

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

use RoundlyConsulting\Coupons\Models\Coupon;

return [
    'model' => Coupon::class,

    // Key type of the polymorphic redeemer column: "bigint", "uuid" or "ulid".
    'key_type' => env('COUPONS_KEY_TYPE', 'bigint'),

    'default_currency' => env('COUPONS_CURRENCY', 'USD'),

    'redeemer' => [
        'track' => env('COUPONS_TRACK_REDEEMERS', true),
    ],

    'code' => [
        'length' => env('COUPONS_CODE_LENGTH', 6),
        'charset' => env('COUPONS_CODE_CHARSET', 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'),
    ],

    'route_key' => env('COUPONS_ROUTE_KEY', 'code'),
];

Every key

Environment

Every key except model is env-backed, so you rarely need to publish the config at all:

COUPONS_KEY_TYPE=bigint
COUPONS_CURRENCY=EUR
COUPONS_TRACK_REDEEMERS=true
COUPONS_CODE_LENGTH=8
COUPONS_CODE_CHARSET=ABCDEFGHJKLMNPQRSTUVWXYZ23456789
COUPONS_ROUTE_KEY=code

COUPONS_TRACK_REDEEMERS takes env-style values: 1, true, on or yes keep tracking on; 0, false, off or no switch it off; a blank value (COUPONS_TRACK_REDEEMERS=) is not set, so tracking stays on. Anything else throws InvalidConfigurationException naming the key.

A key you remove, set to null or leave blank (COUPONS_CURRENCY=) is not set and takes its default; a key you set to a value of the wrong shape throws instead of falling back, and php artisan about shows a broken route_key, default_currency or code.* value as INVALID, with the reason. An unusable code.length or code.charset throws InvalidCouponConfiguration the moment a code is generated — see Generated codes; a non-string route_key or default_currency throws it when read. key_type is read only when the migration runs.