Create short string IDs from numbers
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.idea/runConfigurations
src
tests
.gitignore
.travis.yml
LICENSE
README.md
_config.yml
composer.json
example.php
phpunit.xml.dist
randommap.php

README.md

ShortID PHP

Scrutinizer Code Quality Build Status

Create short string IDs from numbers

Description

This library enable you create a very short string from integer numbers

The basic usage is:

<?php
$shortid = \ByJG\Utils\ShortId::fromNumber(81717788171667188198);

// Will write: Qi0yuM2uKwJb

Methods:

  • fromNumber($number, $map = null): Return a short id from a number
  • fromHex($hex, $map = null): Return a short id from a Hex value
  • get($shortid, $map = null): Return the Unique Integer Number from the short id

Specify your own map:

The base of the short id is in the map definition.

Basically you can create your own sequence here.

The library defines four by default:

  • $MAP_DEFAULT
  • $MAP_ALTERNATE
  • $MAP_NUMBERS_FIRST
  • $MAP_RANDOM

The basic usage is:

<?php
$shortid = \ByJG\Utils\ShortId::fromNumber(
    81717788171667188198,
    \ByJG\Utils\ShortId::$MAP_NUMBERS_FIRST
);

// Will write: G8QokCSkAmz1

Installation

composer require "byjg/shortid=1.0.*"

Tests

phpunit