surely / seq-bundle
序列实现
dev-main
2021-11-26 00:07 UTC
Requires
- php: >=8.0.2
- doctrine/doctrine-bundle: ^2.1
- doctrine/orm: ^2.7
- symfony/config: 5.3.*
- symfony/console: 5.3.*
- symfony/dependency-injection: 5.3.*
Requires (Dev)
- phpunit/phpunit: ^9.5.10
This package is auto-updated.
Last update: 2024-09-26 07:00:48 UTC
README
文档
安装
步骤 1: 下载包
如果你的项目已经使用 Symfony Flex,执行此命令以自动下载、注册和配置包
composer require indragunawan/sequence-bundle
如果你不使用 Symfony Flex 进行安装,首先通过 composer 添加包,然后将 new Indragunawan\SequenceBundle\IndragunawanSequenceBundle()
添加到项目 app/AppKernel.php 文件中注册的包列表中
步骤 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
中查看
序列管理器
注意:序列管理器只能在 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')); }); } }
重置计数器
$ php bin/console indragunawan:sequence:reset-counter sequence_name
你可以将此命令放入 Crontab 以定期重启计数器。
许可证
此包受 MIT 许可证保护。查看完整的许可证。