README

Installation

You can install the package via composer:

composer require inmanturbo/instances

You can run the migrations with:

php artisan instances:migrate

You can publish and run the migrations with:

php artisan vendor:publish --tag="instances-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="instances-config"

This is the contents of the published config file:

return [
    /*
     * Enable or disable the event listeners.
     */
    'enabled' => env('INSTANCES_ENABLED', true),

    /*
     * The model used to store instances.
     */
    'instance_model' => \Inmanturbo\Instances\Models\Instance::class,

    /*
     * The model used to store snapshots.
     */
    'snapshot_model' => \Inmanturbo\Instances\Models\InstanceSnapshot::class,

    /*
     * The number of days to keep instances.
     */
    'prune_after_days' => 365 * 1000000, // wouldn't delete this in a million years,

    /*
     * The table name used to store instances.
     *
     * Changing it is not supported at this time.
     * 
     * It's here for reference and to be used by the `instances:migrate` command.
     */
    'instance_table' => 'instances',

    /*
     * The table name used to store snapshots.
     *
     * Changing it is not supported at this time.
     * 
     * It's here for reference and to be used by the `instances:migrate` command.
     */

    'snapshot_table' => 'instance_snapshots',

    /*
     * These tables will be created when running the migration.
     *
     * They will be dropped when running `php artisan instances:migrate --fresh`.
     */
    'migration_tables' => [
        'instances',
        'instance_snapshots',
    ],
];

Usage

Work in progress. See tests for usage.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• inmanturbo
• spatie/laravel-event-sourcing
• spatie/laravel-deleted-models
• All Contributors

License

The MIT License (MIT). Please see License File for more information.