tuupola/base85

Base85 encoder and decoder for arbitrary data

0.3.1 2017-04-01 04:27 UTC

README

Latest Version Software License Build Status HHVM Status Coverage

Install

Install with composer.

$ composer require tuupola/base85

Usage

This package has both pure PHP and GMP based encoders. By default encoder and decoder will use GMP functions if the extension is installed. If GMP is not available pure PHP encoder will be used instead.

$base85 = new Tuupola\Base85;

$encoded = $base85->encode(random_bytes(128));
$decoded = $base85->decode($encoded);

Note that if you are encoding to and from integer you need to pass boolean true as the second argument for decode() method. This is because decode() method does not know if the original data was an integer or binary data.

$integer = $base85->encode(987654321); /* 3o4PT */
print $base85->decode("3o4PT", true); /* 987654321 */

Also note that encoding a string and an integer will yield different results.

$integer = $base85->encode(987654321); /* 3o4PT */
$string = $base85->encode("987654321"); /* 3B/rU2)I*E0` */

Encoding modes

ASCII85 encoding. This is the default. 0x00000000 is compressed to z. Spaces are not compressed.

use Tuupola\Base85;

$ascii85 = new Base85([
    "characters" => Base85::ASCII85,
    "compress.spaces" => false,
    "compress.zeroes" => true
]);

print $ascii85->encode("Hello world!"); /* 87cURD]j7BEbo80 */

Adobe ASCII85 encoding is same as previous except data is enclosed between <~ and ~>.

use Tuupola\Base85;

$adobe85 = new Base85([
    "characters" => Base85::ASCII85,
    "compress.spaces" => false,
    "compress.zeroes" => true,
    "prefix" => "<~",
    "suffix" => "~>"
]);

print $adobe85->encode("Hello world!"); /* <~87cURD]j7BEbo80~> */

ZeroMQ (Z85) encoding. NOTE! Even though specification says input length must be divisible by 4, this is not currently enforced. Spaces and zeroes are not compressed.

use Tuupola\Base85;

$z85 = new Base85([
    "characters" => Base85::Z85,
    "compress.spaces" => false,
    "compress.zeroes" => false
]);

print $z85->encode("Hello world!"); /* NM=qnZy<MXa+]NF */

Character set from RFC1924 which is an April fools joke. Spaces and zeroes are not compressed.

use Tuupola\Base85;

$rfc1924 = new Base85([
    "characters" => Base85::RFC1924,
    "compress.spaces" => false,
    "compress.zeroes" => false
]);

print $rfc1924->encode("Hello world!"); /* NM&qnZy<MXa%^NF */

Static Proxy

If you prefer static syntax use the provided static proxy.

use Tuupola\Base85Proxy as Base85;

print Base85::encode("Hello world!") /* 87cURD]j7BEbo80 */

To change static proxy options set the Base85::$options variable.

use Tuupola\Base85;
use Tuupola\Base85Proxy as Z85;

Z85::$options = [
    "characters" => Base85::Z85,
    "compress.spaces" => false,
    "compress.zeroes" => false
];

print Z85::encode("Hello world!"); /* NM=qnZy<MXa+]NF */

Short UUID

If you are using UUID:s they can be shortened.

use Ramsey\Uuid\Uuid;
use Tuupola\Base85;

$base85 = new Base85;
$uuid = Uuid::fromString("d84560c8-134f-11e6-a1e2-34363bd26dae");

$base85->encode($uuid->getBytes()); /* fL92h'2K5&U#Ime447uK */
$uuid = Uuid::fromBytes($base85->decode("fL92h'2K5&U#Ime447uK"));
print $uuid; /* d84560c8-134f-11e6-a1e2-34363bd26dae */

Testing

You can run tests either manually...

$ composer test

... or automatically on every code change. This requires entr to work.

$ composer watch

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email tuupola@appelsiini.net instead of using the issue tracker.

License

The MIT License (MIT). Please see License File for more information.