Documentation for larsasub v0.38.2. On an older version? Your release notes ship with the package (CHANGELOG.md).

Model reference#

An index of every model, enum and value object the package ships: which table each model lives in, its relations, and the page that documents it. Use it to look a class up; the behaviour is on the linked page, and the columns are in Database schema.

• Conventions
• Core billing
• Payments
• Credit
• Invoicing
• Provider
• Supporting
• Enums
• Common scopes
• Value objects

Conventions#

Every model extends Models\BaseModel, unless the table says otherwise. The base class gives each model three things:

• The table prefix. Table names go through larsasub.table_prefix (default larsasub_); the tables below show the default.
• The connection. Every model uses larsasub.database.connection, or the default connection when that is null.
• The history channel. HasModelLogs entries go to the package's own larsasub channel, which writes to larsasub_model_logs on the package's connection, never to your default one. Declare model-logger.channels.larsasub yourself to send them elsewhere.

Every concrete model is registered in Laravel's morph map under a larsasub_* alias (larsasub_billable, larsasub_recurring_charge, …), so class names never end up in morph columns and a host using Relation::enforceMorphMap() needs no entries for them. An alias you define yourself for a package model wins; the package then skips its own for that class.

Models are public API, columns included — see Public API. All model classes live under Models\, except the three Mollie models under PaymentProviders\Mollie\Models\.

Core billing#

The registration, the plans and each subscriber's instance of a plan.

larsasub_subscription_change_targets is a pivot table with no model of its own; it backs Subscription::changeTargets().

Payments#

Charges, one-time payments, the payment methods they run on, reminder series and payouts.

RecurringCharge and SinglePayment extend ProviderPaymentModel (see Provider), which supplies their first four relations.

Credit#

The credit wallet. Change balances only through CreditService; see Credit.

Invoicing#

Issued documents and their numbering. Invoices, invoice lines and credit notes are immutable once issued.

Provider#

The provider-neutral base classes and the Mollie models behind them.

MollieCustomer extends ProviderCustomerModel and MollieMandate extends ProviderMandateModel.

Supporting#

Evidence, the notification delivery log and the activity history.

ModelLog is not a LarsaSub class: it is PetersDevelopment\ModelLogger\ModelLog from peters-development/laravel-model-logger. The package creates the larsasub_model_logs table and registers a larsasub log channel that points at it.

Enums#

Machine-readable state lives in enums rather than prose columns, so you can match on it. The backed values are stored and travel in events, so they never change meaning. A release may add a case without calling it breaking, so give every match in your code a default arm: an exhaustive match without one throws UnhandledMatchError on the new case. Classes marked internal are not public API, but where their backed values appear in your config or a published view, those values are.

activated_status is display and audit text and is never queried. Key on the enums — deactivation_reason and activation_source — instead.

Common scopes#

Every model inherits two scopes from BaseModel:

Model::query()->isNotId($modelOrId)->get();          // exclude one record (a model or an id)
Model::query()->createdMoreThanHoursAgo(24)->get();  // created_at older than 24 hours

Models that carry a billable also get forBillable(Model|int $billable) (from Traits\ScopedToBillable), and tenant-aware models get forTenant(?Model $tenant, bool $includeGlobal = false) (from Traits\ScopedToTenant). See Traits and helpers for the scopes the other traits add.

Value objects#

Not models, but part of the public surface: the package returns them, or hands them to your events and hooks. Read their properties by name.

Two classes you may meet while reading the code are internal: Support\VatSnapshot (the frozen VAT decision behind a charge's vat_* columns — read the columns) and Support\ChargeBreakdownEntry (one amount_breakdown entry).