indragunawan/sequence-bundle

序列实现

安装数: 4,289

依赖者: 0

建议者: 0

安全: 0

星标: 5

关注者: 3

分支: 5

公开问题: 2

类型:symfony-bundle

v0.2.1 2020-03-07 19:02 UTC

This package is auto-updated.

Last update: 2024-09-08 13:12:42 UTC


README

文档

安装

步骤 1: 下载包

如果你的项目已经使用 Symfony Flex,执行以下命令以自动下载、注册和配置包

composer require indragunawan/sequence-bundle

如果你不使用 Symfony Flex 进行安装,首先使用 composer 添加包,然后在项目的 app/AppKernel.php 文件中将 new Indragunawan\SequenceBundle\IndragunawanSequenceBundle() 添加到已注册的包列表中

步骤 2: 创建你的序列类

<?php
// src/App/Entity/Sequence.php

namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Indragunawan\SequenceBundle\Model\Sequence as BaseSequence;

/**
* @ORM\Entity(repositoryClass="App\Repository\SequenceRepository")
*/
class Sequence extends BaseSequence
{
    /**
    * @ORM\Id()
    * @ORM\GeneratedValue(strategy="IDENTITY")
    * @ORM\Column(type="integer")
    */
    private $id;

    public function getId()
    {
        return $this->id;
    }
}

步骤 3: 配置包

# app/config/config.yml
indragunawan_sequence:
orm:
    class: App\Entity\Sequence
    manager_name: default #if not set then the default value is 'default'

步骤 4: 更新数据库模式

$ php bin/console doctrine:schema:update --force

使用

将序列手动插入数据库中的序列表

格式

格式可参考下表

预留占位符

  • NUMBER(包含序列计数器的整数)。
  • php 日期格式 查看此
  • Rj, Rn, Ry, RY, Rg 用于日期格式的罗马数字。

示例

另一个示例可查看 Tests/Utils/PlaceholderReplacerTest.php

SequenceManager

注意:序列管理器只能在 doctrine 事务内部使用

在控制器中调用

// use Indragunawan\SequenceBundle\Services\SequenceManager
$sequenceManager = $this->get(SequenceManager::class);
$em->transactional(function () use ($entity) {
  $entity->setSeqNum($sequenceManager->getNextValue('sequence_name'));
});

在事件监听器中调用

// use Indragunawan\SequenceBundle\Services\SequenceManagerInterface
// Inject SequenceManagerInterface on constructor

public function prePersist(LifecycleEventArgs $args)
{
    $entity = $args->getObject();
    if ($entity instanceof EntityClass) {
        $args->getObjectManager()->transactional(function () use ($entity) {
            $entity->setSeqNum($this->sequenceManager->getNextValue('sequence_name'));
        });
    }
}

ResetCounter

$ php bin/console indragunawan:sequence:reset-counter sequence_name

你可以将此命令放入 Crontab 以定期重置计数器。

许可证

此包受 MIT 许可证的约束。查看完整的 许可证