Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alfa6661/laravel-autonumber
Laravel package to create autonumber for Eloquent model
https://github.com/alfa6661/laravel-autonumber
autonumber eloquent eloquent-models laravel
Last synced: 12 days ago
JSON representation
Laravel package to create autonumber for Eloquent model
- Host: GitHub
- URL: https://github.com/alfa6661/laravel-autonumber
- Owner: alfa6661
- Created: 2017-08-03T07:59:43.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-10-15T06:38:00.000Z (about 1 year ago)
- Last Synced: 2024-10-14T22:14:07.962Z (25 days ago)
- Topics: autonumber, eloquent, eloquent-models, laravel
- Language: PHP
- Size: 19.5 KB
- Stars: 45
- Watchers: 2
- Forks: 20
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Laravel AutoNumber
[](https://packagist.org/packages/alfa6661/laravel-autonumber)
[](https://packagist.org/packages/alfa6661/laravel-autonumber)
[](https://styleci.io/repos/99206904)
[](https://packagist.org/packages/alfa6661/laravel-autonumber)
Laravel package to create autonumber for Eloquent model
# Installation
You can install the package via composer:
```
composer require alfa6661/laravel-autonumber
```
Register the ServiceProvider in `config/app.php`
```php
'providers' => [
// ...
Alfa6661\AutoNumber\AutoNumberServiceProvider::class,
],
```
Publish the default configuration
```
php artisan vendor:publish --provider='Alfa6661\AutoNumber\AutoNumberServiceProvider'
```
Running migration
```
php artisan migrate
```
# Usage
Your Eloquent models should use the `Alfa6661\AutoNumber\AutoNumberTrait` trait
The trait contains an abstract method `getAutoNumberOptions()` that you must implement yourself.
```php
use Alfa6661\AutoNumber\AutoNumberTrait;
class Order extends Model
{
use AutoNumberTrait;
/**
* Return the autonumber configuration array for this model.
*
* @return array
*/
public function getAutoNumberOptions()
{
return [
'order_number' => [
'format' => 'SO.?', // autonumber format. '?' will be replaced with the generated number.
'length' => 5 // The number of digits in an autonumber
]
];
}
}
```
You can also pass a `closure` for the format value.
```php
public function getAutoNumberOptions()
{
return [
'order_number' => [
'format' => function () {
return 'SO/' . date('Ymd') . '/?'; // autonumber format. '?' will be replaced with the generated number.
},
'length' => 5 // The number of digits in the autonumber
]
];
}
```
## Saving Model
```php
$order = Order::create([
'customer' => 'Mr. X',
]);
```
The order_number will be automatically generated based on the format given when saving the Order model.
```php
echo $order->order_number;
// SO/20170803/00001
```
## License
Laravel-autonumber is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).
## Contributing
Please report any issue you find in the issues page. Pull requests are more than welcome.