README

This library is used to encode UUIDs created by ramsey/uuid into shorter strings. You are able to define the set of characters used in the encoded string.

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 gubler/uuid-encoder

Use

<?php

use Ramsey\Uuid\Uuid;
use Gubler\UuidEncoder\UuidEncoder;

$uuid = Uuid::uuid4();
$encoder = new UuidEncoder(UuidEncoder::DEFAULT_CHARSET);

$encodedString = $encoder->encode($uuid);

Contributing

Contributions are welcome! Please read CONTRIBUTING for details.

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

Copyright and License

The gubler/uuid-encoder library is copyright © Daryl Gubler and licensed for use under the MIT License (MIT). Please see LICENSE for more information.