uuid README

The project's README from github.com/ramsey/uuid. As one markdown file: README.md.

ramsey/uuid

A PHP library for generating and working with UUIDs.

Source Code Download Package PHP Programming Language Read License Build Status Codecov Code Coverage

ramsey/uuid is a PHP library for generating and working with universally unique identifiers (UUIDs).

This project adheres to a code of conduct. By participating in this project and its community, you are expected to uphold this code.

Much inspiration for this library came from the Java and Python UUID libraries.

Installation

The preferred method of installation is via Composer. Run the following command to install the package and add it as a requirement to your project's composer.json:

composer require ramsey/uuid

Upgrading to Version 4

See the documentation for a thorough upgrade guide:

Documentation

Please see https://uuid.ramsey.dev for documentation, tips, examples, and frequently asked questions.

Contributing

Contributions are welcome! To contribute, please familiarize yourself with CONTRIBUTING.md.

Coordinated Disclosure

Keeping user information safe and secure is a top priority, and we welcome the contribution of external security researchers. If you believe you've found a security issue in software that is maintained in this repository, please read SECURITY.md for instructions on submitting a vulnerability report.

ramsey/uuid for Enterprise

Available as part of the Tidelift Subscription.

The maintainers of ramsey/uuid and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. Learn more.

The ramsey/uuid library is copyright © Ben Ramsey and licensed for use under the MIT License (MIT). Please see LICENSE for more information.

uuid (ramsey/uuid)

Searching Database…

12.6K ·GitHub
What is this?A PHP library for generating and working with universally unique identifiers (UUIDs) — 128-bit IDs you can use to label records and objects without any central coordination.
Is this a standalone app or something I pull into my PHP code?It is a library, not a runnable app: you add it as a requirement to your project's composer.json and call it from your own code.
Which PHP version do I need?It targets modern PHP — the repository is tagged php and php8 — with the exact supported version constraint declared in composer.json for Composer to resolve on install.
I'm still on version 3 — how painful is the move to version 4?Expect breaking changes between major versions: the documentation ships a dedicated, thorough upgrade guide specifically for migrating from version 3 to version 4.
Is it free to use, and is there a paid option?The library is free and open source under the MIT License; enterprises that want commercial support and maintenance can buy in through the Tidelift Subscription.
Where did the design of the library come from?Much of its inspiration came from the Java and Python UUID libraries, so UUID handling from either of those languages will feel familiar here.
Is a GUID different from a UUID?In practice they are the same 128-bit identifier format — GUID is simply Microsoft's naming. The repository is tagged with uuid, guid, and uid alike.
Does it only mint new IDs, or can I work with existing ones too?Both: the README describes it as a library for generating and working with UUIDs, so you can represent and manipulate UUID values in your code, not just create new ones.
Is this a battle-tested project?Yes — it dates back to 2012, has over 12,600 GitHub stars, runs continuous integration, and offers commercial maintenance through Tidelift.
Creator
ramsey
Size
3.2 MB
Stars
12.6K
Age
14y
Commits · 90 Days