Download the PHP package infocyph/uid without Composer

UID

An AIO Unique ID generator written in PHP. Supports,

• UUID (RFC 4122 + Unofficial/Draft)
• ULID (ulid specification)
• Snowflake ID (Twitter Snowflake)
• Sonyflake ID (Snowflake Inspired, ported from Golang)
• TBSL (library exclusive)

Table of contents

• Prerequisites
• Installation
• Usage
  • UUID
    • UUID v1
    • UUID v3
    • UUID v4
    • UUID v5
    • UUID v6
    • UUID v7
    • UUID v8
    • Additional
  • ULID
  • Snowflake ID
  • Sonyflake ID
  • TBSL ID
• Benchmark
• Support
• References

Prerequisites

Language: PHP 8/+

Installation

Usage

UUID (Universal Unique Identifier)

The node specific UUID's $node parameter (1, 6, 7, 8) is optional. If not provided, it will be generated randomly. But, if you wanna track the source of the UUIDs, you should use it (pre-define the node per server & pass it accordingly).

UUID v1: Time-based UUID.

• Generate v1 UUID

• Pass your pre-generated node (for node specific UUID)

UUID v3: Namespace based UUID.

• Generate v3 UUID

• Get v3 UUID for predefined namespaces (RFC4122 #Appendix C)

• You can generate a UUID & use as namespace as well

UUID v4: Random UUID.

• Generate v4 UUID

UUID v5: Namespace based UUID.

• Generate v5 UUID

• Get v5 UUID for predefined namespaces (RFC4122 #Appendix C)

• You can generate a UUID & use as namespace as well

UUID v6 (draft-based/unofficial): Time-based UUID.

• Generate v6 UUID

• Get v6 UUID using predefined node:

UUID v7 (draft-based/unofficial): Time-based UUID.

• Generate v7 UUID

• Get v7 UUID using predefined node:

• Or if you wanna get v7 UUID using predefined time:

• You can combine both parameters together as well.

UUID v8 (draft-based/unofficial): Time-based UUID. Lexicographically sortable.

• Generate v8 UUID

• Get v8 UUID using predefined node:

Additional

• Generate node for further use (with version: 1, 6, 7, 8)

• Parse any UUID string:

ULID (Universally Unique Lexicographically Sortable Identifier)

• Generating ULID is very simple,

• Or if you wanna get ULID for specific time:

• Extract datetime from any ULID string:

• Validate any ULID string:

Snowflake ID

• Generate a new Snowflake ID (You can also pass your pre-generated worker_id & datacenter_id for server/module detection):

• Parse Snowflake ID (get the timestamp, sequence, worker_id, datacenter_id from any Snowflake ID):

• Specify start time for Snowflake ID (a Snowflake ID is unique upto 69 years from the start date):

Sonyflake ID

• Generate a new Sonyflake ID (You can also pass your pre-generated machine_id for server detection):

• Parse Sonyflake ID (get the timestamp, sequence, machine_id from any Snowflake ID):

• Specify start time for Sonyflake ID (a Sonyflake ID is unique upto 174 years from the start date):

TBSL: Time-Based Keys with Lexicographic Sorting (library exclusive)

• Get TBSL ID (You can also pass your pre-generated machine_id for server detection):

• Parse TBSL ID (get the timestamp, machine_id):

Benchmark

Support

Having trouble? Create an issue!

References

• UUID (RFC4122): https://tools.ietf.org/html/rfc4122
• UUID (Drafts/Proposals): https://datatracker.ietf.org/doc/draft-ietf-uuidrev-rfc4122bis
• ULID: https://github.com/ulid/spec
• Snowflake ID: https://github.com/twitter-archive/snowflake/tree/snowflake-2010
• Sonyflake ID: https://github.com/sony/sonyflake