testmonitor/eloquent-incrementable

Define a custom auto-increment field in your Eloquent model, that is determined through PHP rather than your database engine.

6.0.0 2024-11-27 11:09 UTC

Requires

• php: ^8.2
• illuminate/config: ^11.0
• illuminate/database: ^11.0
• illuminate/support: ^11.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.7
• orchestra/testbench: ^9.0
• phpunit/phpunit: ^11.0
• squizlabs/php_codesniffer: ^3.6

MIT

• Thijs Kok
• Stephan Grootveld
• Frank Keulen

• model
• laravel
• eloquent
• count
• increment
• testmonitor

README

Define a custom auto-increment field in your Eloquent model, that is determined through PHP rather than your database engine.

Furthermore, by making use of increment groups, you can restart counting in-table based on other fields. Consider this example:

Imagine a bug tracking application that stores each bug in a single table, but is represented on a per-project basis. You'll want start each project with a fresh bug count, while maintaining a unique database id. Incrementable will enable you to automatically reset the code counter once a new project_id is defined.

Table of Contents

• Installation
• Usage
• Examples
• Tests
• Changelog
• Contributing
• Credits
• License

Installation

This package can be installed through Composer:

$ composer require testmonitor/eloquent-incrementable

Usage

In order to add Incrementable to your Eloquent model, you'll need to:

1. Use the trait TestMonitor\Incrementable\Traits\Incrementable on your model(s).
2. Configure the incrementable field (note: make sure its an integer column).
3. Optionally, add one or more increment groups.

Add the Incrementable trait on the models you want to track:

use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;
use TestMonitor\Incrementable\Traits\Incrementable;

class Bug extends Model
{
    use Incrementable, SoftDeletes;

    protected $table = 'bugs';

    protected $incrementable = 'code';

    // This will cause the code to reset once
    // a new project_id is found.
    protected $incrementableGroup = ['project_id'];
}

In order to avoid collisions, Incrementable will preserve the count for a soft-deleted model. Although this will cause a gap between this and the next model, it will ensure uniqueness when the model is restored.

Examples

In this example, we have set up the following:

• A table containing a name and code field.
• An Eloquent model called App\Bug, which uses the Incrementable trait
• A property on the Bug model: $incrementable = 'code'

We can now run this example:

$bug = new App\Bug(['name' => 'It doesn\'t work.']);
$bug->save();

// Will show '1'
echo $bug->code;

$bug = new App\Bug(['name' => 'It really doesn\'t work.']);
$bug->save();

// Will show '2'
echo $bug->code;

Tests

The package contains integration tests. You can run them using PHPUnit.

$ vendor/bin/phpunit

Changelog

Refer to CHANGELOG for more information.

Contributing

Refer to CONTRIBUTING for contributing details.

Credits

• Thijs Kok
• Stephan Grootveld
• Frank Keulen
• All Contributors

License

The MIT License (MIT). Refer to the License for more information.