https://github.com/decodelabs/guidance

Generalised UUID generation and parsing interface for PHP
https://github.com/decodelabs/guidance

Last synced: 1 day ago
JSON representation

Generalised UUID generation and parsing interface for PHP

• Host: GitHub
• URL: https://github.com/decodelabs/guidance
• Owner: decodelabs
• License: mit
• Created: 2023-11-13T23:19:22.000Z (about 1 year ago)
• Default Branch: develop
• Last Pushed: 2024-09-04T21:14:58.000Z (4 months ago)
• Last Synced: 2024-12-17T08:11:35.477Z (24 days ago)
• Language: PHP
• Size: 60.5 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Guidance

[![PHP from Packagist](https://img.shields.io/packagist/php-v/decodelabs/guidance?style=flat)](https://packagist.org/packages/decodelabs/guidance)

[![Latest Version](https://img.shields.io/packagist/v/decodelabs/guidance.svg?style=flat)](https://packagist.org/packages/decodelabs/guidance)

[![Total Downloads](https://img.shields.io/packagist/dt/decodelabs/guidance.svg?style=flat)](https://packagist.org/packages/decodelabs/guidance)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/decodelabs/guidance/integrate.yml?branch=develop)](https://github.com/decodelabs/guidance/actions/workflows/integrate.yml)

[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-44CC11.svg?longCache=true&style=flat)](https://github.com/phpstan/phpstan)

[![License](https://img.shields.io/packagist/l/decodelabs/guidance?style=flat)](https://packagist.org/packages/decodelabs/guidance)

### Generalised UUID generation and parsing interface

Guidance provides a simplified interface for generating and parsing UUIDs of various types. It is designed to be used as a common interface for other libraries that need to work with UUIDs, without having to worry about the specifics of each type and implementation of the generator.

Guidance provides a stripped down front end over the [Ramsey UUID](https://uuid.ramsey.dev) library by default, but can be extended to support other implementations where required.

_Get news and updates on the [DecodeLabs blog](https://blog.decodelabs.com)._

---

## Installation

Install via Composer:

```bash

composer require decodelabs/guidance

```

## Usage

```php

use DecodeLabs\Guidance;

use DecodeLabs\Guidance\Format;

// Generate a v4 UUID

$v4 = Guidance::createV4();

$version = $v4->getVersion(); // Version::V4

$string1 = (string)$v4; // Full UUID string

$string2 = $v4->shorten(); // Base 62 (default) encoded UUID

$string3 = $v4->shorten(Format::FlickrBase58); // Base 58 encoded UUID

$new1 = Guidance::from($string1); // Parse full UUID string

$new2 = Guidance::fromShortString($string3, Format::FlickrBase58);

```

## Licensing

Guidance is licensed under the MIT License. See [LICENSE](./LICENSE) for the full license text.