https://github.com/ghostwriter/uuid
Provides sortable Universally Unique Identifiers (UUID) using Unix timestamp.
https://github.com/ghostwriter/uuid
ghostwriter uuid uuid-7
Last synced: 28 days ago
JSON representation
Provides sortable Universally Unique Identifiers (UUID) using Unix timestamp.
- Host: GitHub
- URL: https://github.com/ghostwriter/uuid
- Owner: ghostwriter
- License: other
- Created: 2024-07-21T02:06:47.000Z (10 months ago)
- Default Branch: 1.0.x
- Last Pushed: 2025-04-22T00:54:13.000Z (29 days ago)
- Last Synced: 2025-04-22T01:31:51.707Z (29 days ago)
- Topics: ghostwriter, uuid, uuid-7
- Language: PHP
- Homepage: https://github.com/ghostwriter/uuid
- Size: 331 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Uuid
[](https://github.com/sponsors/ghostwriter)
[](https://github.com/ghostwriter/uuid/actions/workflows/automation.yml)
[](https://www.php.net/supported-versions)
[](https://packagist.org/packages/ghostwriter/uuid)
Version 7 UUIDs using a Unix timestamp for PHP
## Installation
You can install the package via composer:
``` bash
composer require ghostwriter/uuid
```
### Star ⭐️ this repo if you find it useful
You can also star (🌟) this repo to find it easier later.
## Usage
Initialize a new Uuid instance with a given UUID string
```php
use Ghostwriter\Uuid\Uuid;
$uuid = new Uuid('0000669c-8deb-7fe7-b9cc-692b216999a3');
// or
$uuid = Uuid::fromString('0000669c-8deb-7fe7-b9cc-692b216999a3');
echo $uuid->toString(); // 0000669c-8deb-7fe7-b9cc-692b216999a3
```
Generate a new UUID
```php
echo Uuid::new()->toString(); // 0000669c-8f99-711e-9ed0-72a35c3b6fb3
```
Generate a new UUID with a specific timestamp
```php
echo Uuid::new(new DateTimeImmutable())->toString(); // 0000669c-8faf-7e4b-9ed9-45c4c2b27f07
```
Compare and Sort UUIDs based on their timestamp ( `0: equal`, `1: older`, `-1: newer`)
```php
$uuidLastYear = Uuid::new(new DateTimeImmutable('-1 year'));
$uuidLastMonth = Uuid::new(new DateTimeImmutable('-1 month'));
$uuidLastWeek = Uuid::new(new DateTimeImmutable('-1 week'));
// LastYear comparisons
// 0: LastYear is the same as LastYear
assert(0 === $uuidLastYear->compare($uuidLastYear));
// -1: LastMonth is newer than LastYear
assert(-1 === $uuidLastYear->compare($uuidLastMonth));
// -1: LastWeek is newer than LastYear
assert(-1 === $uuidLastYear->compare($uuidLastWeek));
// LastMonth comparisons
// 1: LastYear is older than LastMonth
assert(1 === $uuidLastMonth->compare($uuidLastYear));
// 0: LastMonth is the same as LastMonth
assert(0 === $uuidLastMonth->compare($uuidLastMonth));
// -1: LastWeek is newer than LastMonth
assert(-1 === $uuidLastMonth->compare($uuidLastWeek));
// LastWeek comparisons
// 1: LastYear is older than LastWeek
assert(1 === $uuidLastWeek->compare($uuidLastYear));
// 1: LastMonth is older than LastWeek
assert(1 === $uuidLastWeek->compare($uuidLastMonth));
// 0: LastWeek is the same as LastWeek
assert(0 === $uuidLastWeek->compare($uuidLastWeek));
/** @var array{0:UuidInterface,1:UuidInterface,2:UuidInterface,3:UuidInterface} $uuids */
$uuids = [$uuidLastWeek, $uuidLastYear, $uuidLastMonth];
usort($uuids, static fn (UuidInterface $left, UuidInterface $right): int => $left->compare($right));
// First: LastYear (oldest)
assert($uuidLastYear === $uuids[0]);
// Second: LastMonth
assert($uuidLastMonth === $uuids[1]);
// Third: LastWeek
assert($uuidLastWeek === $uuids[2]);
```
### Credits
- [Nathanael Esayeas](https://github.com/ghostwriter)
- [All Contributors](https://github.com/ghostwriter/uuid/contributors)
### Changelog
Please see [CHANGELOG.md](./CHANGELOG.md) for more information on what has changed recently.
### License
Please see [LICENSE](./LICENSE) for more information on the license that applies to this project.
### Security
Please see [SECURITY.md](./SECURITY.md) for more information on security disclosure process.