Accountant

# Configuration

This section describes some of the basic configuration settings of the package.

# Ledger implementation

The Altek\Accountant\Models\Ledger implementation is set by omission.

return [
    
    'ledger' => [
        'implementation' => Altek\Accountant\Models\Ledger::class,
        
        // ...
    ],

    // ...
];

TIP

Read the Ledger Implementation documentation for more details.

# Ledger driver

The bundled Database driver is set as default.

return [

    'ledger' => [
        // ...

        'driver' => 'database',
    ],

    // ...
];

TIP

For custom implementation details, check the Ledger Drivers reference.

# Ledger date serialisation format

Since Laravel 7.0, the default date serialisation format (opens new window) is ISO-8601 (opens new window) including fractional seconds and timezone information.

To make the framework upgrade easy, the old date serialisation format is set as default.

return [

    'ledger' => [
        // ...

        'date_format' => 'Y-m-d H:i:s',
    ],

    // ...
];

TIP

To use the new date serialisation format, set the date_format value to null.

# Recording Contexts

There are three recording contexts.

Name Constant Value Resolved when running
Testing Altek\Accountant\Context::TEST 1 PHPUnit, ...
Command Line Interface Altek\Accountant\Context::CLI 2 Migrations, Jobs, Commands, Tinker, ...
Web Altek\Accountant\Context::WEB 4 Apache, CGI, FPM, ...

By default, the package is set to record only in the Altek\Accountant\Context::WEB context.

To enable other contexts, set the accountant.contexts value to a context bit mask (opens new window).

The following example promotes all the available contexts for recording.

return [

    // ...
    
    'contexts' => Altek\Accountant\Context::TEST | Altek\Accountant\Context::CLI | Altek\Accountant\Context::WEB,

    // ...
];

To disable recording entirely, set the accountant.contexts value to zero:

return [

    // ...
    
    'contexts' => 0,

    // ...
];

# User

This package supports multiple user types through the use of a MorphTo relation.

# Prefix

By default, the columns used for the User relation are user_id and user_type.

For a different user column prefix, change the configuration value and update the Ledger Table columns accordingly.

return [
    // ...

    'user' = [
        'prefix' => 'accountable',
    ],
];

# Auth Guards

Specify which authentication guards the default UserResolver should use when trying to resolve a user.

return [
    // ...

    'user' = [
        // ...

        'guards' => [
            'web',
        ],
    ],
];

TIP

Refer to the User Resolver section for additional information.

← Model Setup →