eric-chau/bijective

Simple bijective function (base(n) encode/decode) for PHP.

Maintainers

Details

github.com/eric-chau/bijective

Source

Issues

Installs: 2 421

Dependents: 2

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 1

Open Issues: 0

pkg:composer/eric-chau/bijective

v1.0.0 2016-02-04 22:03 UTC

Requires

  • php: >=5.3.3

Requires (Dev)

MIT 98b4d22c39a4dd8572f4eda144ff7871f6c2c459

  • Eric Chau <eriic.chau.woop@gmail.com>

This package is not auto-updated.

Last update: 2025-10-26 00:56:02 UTC

README

Bijective encodes any integer into a base(n) string where n is alphabet's length. It can be very useful if you want to create your own url shortener.

<?php

require_once __DIR__ . '/vendor/autoload.php';

$bijective = new \Jarvis\Math\Bijective();

echo $bijective->alphabet(); // print 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'

echo $bijective->encode('64'); // print 'bc'

echo $bijective->decode('ba'); // print '62'

$bijective = new \Jarvis\Math\Bijective('azerty');

echo $bijective->alphabet(); // print 'azerty'

Things you should know:

  • Bijective default alphabet is abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789. You can define your own alphabet by passing it to its constructor.
  • Bijective throws exception if you try to decode unsupported char.
  • Bijective throws exception if you try to decode string which start by a zero value (the first char of your defined alphabet. Given the bijective with alphabet '!?:;', the zero value is '!').
  • every exception throws by Bijective is instance of \LogicException.