oire/base64

URL-and filename-safe Base64 handling.

Oirë Base64, URL-safe Base64 Handling

Note! This library is not maintained anymore.

Please use Iridium security library instead., _(*1)

, _(*2)

Encodes data to Base64 URL-safe way and decodes encoded data., _(*3)

Requirements

This library requires PHP 7.3 or above., _(*4)

Installation

Install via Composer:, _(*5)

composer require oire/base64

Running Tests

Run ./vendor/bin/phpunit in the project directory., _(*6)

Compatibility with Earlier Versions of PHP

If you want a version compatible with PHP 7.1.2, please install version 1 instead:, _(*7)

composer require "oire/base64 ^1"

Usage Examples

use Oire\Base64\Base64;
use Oire\Base64\Exception\Base64Exception;

$text = "The quick brown fox jumps over the lazy dog";
$encoded = Base64::encode($text);
echo $encoded.PHP_EOL;

This will output:, _(*8)

VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZw

By default, the encode() method truncates padding = signs as PHP’s built-in decoder handles this correctly. However, if the second parameter is given and set to true, = signs will be replaced with tildes (~), i.e.:, _(*9)

$encoded = Base64::encode($text, true);
echo $encoded.PHP_EOL;
````

This will output:  
```shell
VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZw~~

To decode the data, simply call Base64::decode():, _(*10)

$encoded = "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZw";

try {
    $decoded = Base64::decode($encoded);
} catch(Base64Exception $e) {
    // Handle errors
}

echo $decoded.PHP_EOL;

This will output:, _(*11)

The quick brown fox jumps over the lazy dog

License

Copyright © 2017-2021, Andre Polykanine also known as Menelion Elensúlë, The Magical Kingdom of Oirë.
This software is licensed under an MIT license., _(*12)