Download the PHP package meita/journal-guard without Composer

meita/journal-guard

Guard and validate journal entries before they are posted to the ledger. Built for Laravel 10/11/12 with extensible rule classes and clear, human-readable errors.

Installation

Configuration

config/journal-guard.php ships with:

• enabled: toggle the guard.
• mode: strict (throws) or warning (returns warnings, no throw).
• rules: ordered list of rule classes.
• account_model, period_model, currency_model: optional model classes for built-in rules.
• resolvers.account|period|currency: optional callbacks to resolve accounts/periods/currency without coupling to models.
• default_currency, enforce_default_currency: enforce default currency when needed.

Example resolver registration:

Usage

Validating a payload

Warning mode

Trait for services

Custom rules

Create a rule implementing Meita\JournalGuard\Contracts\RuleInterface and add it to the rules config array.

Middleware-like usage

Built-in rules

• BalancedRule: total debit equals total credit; totals must be > 0.
• PositiveAmountsRule: no negatives, no line with both debit and credit, no empty amounts.
• AccountsActiveRule: accounts exist and are active (via resolver or configured model).
• ClosedPeriodRule: entry date falls within an open period (resolver or model).
• CurrencyRule: currency allowed for the company and default currency enforcement.

Events

• JournalValidating
• JournalValidated
• JournalRejected

Hook into these with Laravel's event listeners to log, audit, or instrument validation.