病毒php/自动编号

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

v1.5 2024-07-04 03:21 UTC

This package is auto-updated.

Last update: 2024-09-04 03:39:34 UTC


README

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

安装

您可以通过 composer 安装此包

composer require virusphp/autonumbering

config/app.php 中注册 ServiceProvider

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

发布默认配置

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

运行迁移

php artisan migrate

用法

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

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

use Virusphp\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' => 'PO.?', // 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 'PO/' . 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. PO',
]);

在保存订单模型时,order_number 将根据给定的格式自动生成。

echo $order->order_number;

// PO/20170803/00001

许可证

Laravel-autonumber 是开源软件,许可协议为 MIT 许可证

贡献

请在问题页面上报告您发现的所有问题。拉取请求非常受欢迎。