README

Laravel 包用于为 Eloquent 模型创建自动编号

安装

您可以通过 composer 安装此包

composer require alfa6661/laravel-autonumber

在 config/app.php 中注册 ServiceProvider

'providers' => [
    // ...
    Alfa6661\AutoNumber\AutoNumberServiceProvider::class,
],

发布默认配置

php artisan vendor:publish --provider='Alfa6661\AutoNumber\AutoNumberServiceProvider'

运行迁移

php artisan migrate

用法

您的 Eloquent 模型应使用 Alfa6661\AutoNumber\AutoNumberTrait 特性

该特性包含一个抽象方法 getAutoNumberOptions()，您必须自行实现。

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
            ]
        ];
    }

}

您也可以传递一个 闭包 用于格式化值。

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
        ]
    ];
}

保存模型

$order = Order::create([
    'customer' => 'Mr. X',
]);

在保存 Order 模型时，order_number 将根据提供的格式自动生成。

echo $order->order_number;

// SO/20170803/00001

许可证

Laravel-autonumber 是开源软件，采用MIT 许可证。

贡献

请在问题页面报告您发现的任何问题。我们非常欢迎 pull request。