Extending, events & exceptions

The provider binds six contracts from config. Point the config key at your class, or bind the contract in your own service provider (a later binding wins). All classes live under RoundlyConsulting\Shops:

// AppServiceProvider::register()
$this->app->bind(\RoundlyConsulting\Shops\Contracts\PaymentGateway::class, AcmePayGateway::class);

Also shipped: Support\Tax\ConfigTaxResolver and Reviews\DatabaseVerifiedPurchaseResolver. Swappable models: shops.shop_model (the tenant) and shops.discounts.coupon_model (a coupons Coupon subclass).

Traits for your own models

BelongsToShop, HasPublishing and HasTranslations work on any model. For translations, implement Translatable and cast each translatable attribute to array:

use Illuminate\Database\Eloquent\Model;
use RoundlyConsulting\Shops\Concerns\BelongsToShop;
use RoundlyConsulting\Shops\Concerns\HasPublishing;
use RoundlyConsulting\Shops\Concerns\HasTranslations;
use RoundlyConsulting\Shops\Contracts\Translatable;

final class Banner extends Model implements Translatable
{
    use BelongsToShop, HasPublishing, HasTranslations;

    public function translatableAttributes(): array
    {
        return ['headline'];
    }

    protected function casts(): array
    {
        return ['headline' => 'array', 'published_at' => 'datetime'];
    }
}

Banner::query()->forShop($shop)->published()->get();

Service classes

• Orders\AddressBook (Shops::addresses()) — maps addresses-for-laravel addresses to order Address objects (defaults() returns OrderAddresses, map()).
• Payments\StoreCreditTender — applies store credit (apply()) and returns it (restore(), which cancel() runs).
• Shops\CurrentShop (Shops::current()) — the active tenant, scoped per request and per queued job.
• Support\ShopModel and Support\CouponModel — resolve the configured models (class(), and query() on ShopModel).
• Support\Casts\AddressCast — a JSON ⇄ Address cast, reusable on your own models.

Events

During place-order, coupons-for-laravel fires its own CouponRedeemed, CouponRedemptionFailed and CouponExhausted events.

Exceptions

Package exceptions extend the abstract RoundlyConsulting\Shops\Exceptions\ShopsException (a RuntimeException):

Money errors come from money-for-laravel and do not extend ShopsException — CurrencyMismatch (a variant in another currency, re-denominating a price column, mixed-currency math), UnknownCurrency and InvalidMoneyValue among others. Sluggable, coupons and credits throw their own exceptions.