Skip to main content

Methods Reference

This page describes all available methods in the ShortID library.

fromNumber()​

Convert an integer number to a short ID string.

public static function fromNumber(int $number, ?string $map = null): string

Parameters​

  • $number (int): The number to convert
  • $map (string|null): Optional custom character map (defaults to $MAP_DEFAULT)

Returns​

  • (string): The short ID representation

Example​

use ByJG\ShortId\ShortId;

$shortid = ShortId::fromNumber(1234567890);
echo $shortid; // Output: bjme

// With custom map
$shortid = ShortId::fromNumber(1234567890, ShortId::$MAP_NUMBERS_FIRST);
echo $shortid; // Output: 19c4

get()​

Convert a short ID string back to its original number.

public static function get(string $shortId, ?string $map = null): float|int
warning

This method does not work with UUIDs converted using fromUuid() because UUIDs are split into multiple parts during conversion.

Parameters​

  • $shortId (string): The short ID to decode
  • $map (string|null): Optional custom character map (must match the one used for encoding)

Returns​

  • (int|float): The original number

Example​

use ByJG\ShortId\ShortId;

$number = ShortId::get('bjme');
echo $number; // Output: 1234567890

// With custom map
$number = ShortId::get('19c4', ShortId::$MAP_NUMBERS_FIRST);
echo $number; // Output: 1234567890

fromHex()​

Convert a hexadecimal string to a short ID.

public static function fromHex(string $hex, ?string $map = null): string

Parameters​

  • $hex (string): Hexadecimal string (with or without dashes)
  • $map (string|null): Optional custom character map

Returns​

  • (string): The short ID representation

Example​

use ByJG\ShortId\ShortId;

$shortid = ShortId::fromHex('3e');
echo $shortid; // Output: ab

$shortid = ShortId::fromHex('f04');
echo $shortid; // Output: aab

fromUuid()​

Convert a UUID to a short ID string.

public static function fromUuid(string $uuid, ?string $map = null): string
info

The UUID is split into multiple parts and each part is converted separately. This means you cannot use get() to reverse this conversion.

Parameters​

  • $uuid (string): UUID string (with or without dashes)
  • $map (string|null): Optional custom character map

Returns​

  • (string): The short ID representation

Example​

use ByJG\ShortId\ShortId;

$shortid = ShortId::fromUuid('092395A6-BC87-11ED-8CA9-0242AC120002');
echo $shortid; // Output: a2BU6bLxLieeALmbPW3QuK

$shortid = ShortId::fromUuid('092609DD-BC87-11ED-8CA9-0242AC120002');
echo $shortid; // Output: OKgJdeLxLieeALmbPW3QuK

fromRandom()​

Generate a random short ID.

public static function fromRandom(
    int $min = 2147483647,
    int $max = 9223372036854775807,
    ?string $map = null
): string

Parameters​

  • $min (int): Minimum random value (default: 2147483647)
  • $max (int): Maximum random value (default: 9223372036854775807)
  • $map (string|null): Optional custom character map

Returns​

  • (string): A random short ID

Example​

use ByJG\ShortId\ShortId;

$shortid = ShortId::fromRandom();
echo $shortid; // Output: random string, e.g., "aBc123"

// With custom range
$shortid = ShortId::fromRandom(1000, 9999);
echo $shortid; // Output: random short ID from smaller range

Summary Table​

MethodInputOutputReversible
fromNumber()IntegerShort ID✅ Yes (via get())
fromHex()HexadecimalShort ID✅ Yes (via get())
fromUuid()UUIDShort ID❌ No
fromRandom()RangeShort ID✅ Yes (via get())
get()Short IDIntegerN/A