README

Credits

This repository is a fork from original xobotyi/basen, because original repository is not maintained anymore.

About

PHP is a great language but unfortunately provides us with only one text encoding (base64) which even not URL safe. And there are no straight way to change its alphabet.
BaseN solves that problem and implements common binary-to-text algorithm for encodings whose alphabet fully covers number of bits that corresponds its length. And rough algorithm which will encode each byte separately, it is less compact but guarantee the encoding with given alphabet.
Furthermore it gives you methods to encode and decode integers themselves instead of their text representation.

Requirements

• PHP 8.3+

Installation

Install with composer

composer require chongyi/php-basen

Usage

use PHPBaseN\BaseN;
use PHPBaseN\Base58;

// use it for something usual
$base8 = new BaseN('01234567', false, false, false);
echo $base8->encode(16) . "\n"; // 142330
echo $base8->encodeInt(16) . "\n"; // 20

// or create your own encoder with own alphabet if needed
$myOwnEncoder = new BaseN('a123d8e4fiwnmqkl', false, true, true);
echo $myOwnEncoder->encode(16) . "\n"; // 313e
echo $myOwnEncoder->encodeInt(16) . "\n"; // 1a

// predefined encoder
echo Base58::encode(16) . "\n"; // 3hC
// or, with alternative alphabet
echo Base58::encode(16, Base58::ALPHABET_RIPPLE) . "\n"; // hkD
echo Base58::encodeInt(16) . "\n"; // G

Builtin encodings

BaseN provides few classes implementing most popular encodings:

• Base16 (0-9a-f)
• Base32 (a-z2-7)
• Base36 (0-9a-z)
• Base58 (0-9A-Za-v)
• Base62 (0-9A-Za-z)
• Base64 (0-9A-Za-z+/)
• Base85 (!"#$%&'()*+,-./0-9:;<=>?@A-Z[]^_`a-u)