Packages/DigiComp.Sequence
2
0
Fork 0
Code Pull requests Releases Activity

optimized README.md

Browse source
This commit is contained in:
Robin Krahnen 2021-09-10 12:37:11 +02:00
parent d5f8b671d5
commit 83839a1582
1 changed files with 15 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -1,22 +1,20 @@
DigiComp.Sequence
-------------------------
# DigiComp.Sequence
This is a very simple and stupid tool, helping in generation of gapless sequences. For this task it relies on key
integrity of the database of your choice.
This is a very simple tool, helping in generation of gapless sequences. For this task it relies on key integrity of the
database of your choice.
Usage is quite simple also:
/**
* @param \DigiComp\Sequence\Service\SequenceNumberGenerator $sequenceNumberGenerator
```php
/**
* @param SequenceNumberGenerator $sequenceNumberGenerator
*/
public function __construct(SequenceNumberGenerator $sequenceNumberGenerator)
{
public function __construct(SequenceNumberGenerator $sequenceNumberGenerator)
{
$this->orderId = $sequenceNumberGenerator->getNextNumberFor($this);
}
}
```
``getNextNumberFor`` allows you to give an object which will be resolved to its FQCN or a custom sequence name.
`getNextNumberFor` allows you to give an object (which will be resolved to its FQCN) or a custom sequence name.
The CommandController helps you to advance the current sequence number, in case of migrations or similar.
See ``./flow help sequence:advance`` if interested.
The `SequenceCommandController` helps you to advance the current sequence number, in case of migrations or similar. See
`./flow help sequence:advance` if interested.