tiny-blocks/encoder

Encoder and decoder for arbitrary data.

3.0.0 2024-12-03 02:34 UTC

Requires

• php: ^8.3
• ext-bcmath: *

Requires (Dev)

• infection/infection: ^0.29
• phpmd/phpmd: ^2.15
• phpstan/phpstan: ^1
• phpunit/phpunit: ^11
• squizlabs/php_codesniffer: ^3.11

Suggests

• ext-bcmath: Enables the extension which is an interface to the GNU implementation as a Basic Calculator utility library.

MIT

• Gustavo Freze de Araujo Santos

• encoder
• decoder
• psr
• base62
• tiny-blocks

README

• Overview
• Installation
• How to use
• License
• Contributing

Overview

Encoder and decoder for arbitrary data.

Installation

composer require tiny-blocks/encoder

How to use

The library provides concrete implementations of the Encoder interface, enabling encoding and decoding of data into specific formats like Base62.

Using Base62

To encode a value into Base62 format:

$encoder = Base62::from(value: 'Hello world!');
$encoded = $encoder->encode();

# Output: T8dgcjRGuYUueWht

To decode a Base62-encoded value back to its original form:

$encoder = Base62::from(value: 'T8dgcjRGuYUueWht');
$decoded = $encoder->decode();

# Output: Hello world!

If you attempt to decode an invalid Base62 value, an InvalidDecoding exception will be thrown:

try {
    $encoder = Base62::from(value: 'invalid_value');
    $decoded = $encoder->decode();
} catch (InvalidDecoding $exception) {
    echo $exception->getMessage();
    # Output: The value <invalid_value> could not be decoded.
}

License

Encoder is licensed under MIT.

Contributing

Please follow the contributing guidelines to contribute to the project.