rayne/ecoji

Encodes (and decodes) data as emojis. Implementation of the Ecoji Standard.

Ecoji for PHP 🏣🔉🦐🔼🍉🔹🦒📲🐒🍍🀄☕

Ecoji encodes data as 1024 emojis. It's like base1024 with an emoji character set. Visit ecoji.io to try Ecoji in your browser., _(*1)

rayne/ecoji is a PHP port of Ecoji with 100% test coverage., _(*2)

, _(*3)

Contents

• Installation
• Encoding
• Decoding
• Streams
• CLI
• Docker

Installation

composer require rayne/ecoji

Encoding

use Rayne\Ecoji\Ecoji;

$ecoji = new Ecoji;
$ecoji->encode("Base64 is so 1999, isn\'t there something better?\n");

🏗📩🎦🐇🎛📘🔯🚜💞😽🆖🐊🎱🥁🚄🌱💞😭💮🇵💢🕥🐭🔸🍉🚲🦑🐶💢🕥🔮🔺🍉📸🐮🌼👦🚟🥴📑

Decoding

use Rayne\Ecoji\Ecoji;

$ecoji = new Ecoji;
$ecoji->decode('🏗📩🎦🐇🎛📘🔯🚜💞😽🆖🐊🎱🥁🚄🌱💞😭💮🇵💢🕥🐭🔸🍉🚲🦑🐶💢🕥🔮🔺🍉📸🐮🌼👦🚟🥴📑');

Base64 is so 1999, isn't there something better?

Streams

use Rayne\Ecoji\Ecoji;

$ecoji = new EcojiStream;
$ecoji->encode($sourceStream, $destinationStream);
$ecoji->decode($sourceStream, $destinationStream);

EcojiStream doesn't wrap the encoded stream without configuring the wrap length first. A value of 0 disables wrapping., _(*4)

use Rayne\Ecoji\Ecoji;

$ecoji = new EcojiStream;
$ecoji->setWrap(80);

CLI

The CLI encodes and decodes files and streams., _(*5)

./bin/ecoji --help

Usage: ecoji [OPTIONS]... [FILE]

Encode or decode data as Unicode emojis. 😁

Options:
    -d, --decode          Decode data.
    -w, --wrap COLS       Wrap encoded lines after COLS characters (default 76).
                          Use 0 to disable line wrapping.
    -h, --help            Print this message.
    -v, --version         Print version information.

Installing the Composer package rayne/ecoji will create a symlink, e.g. vendor/bin/ecoji., _(*6)

Docker

Launch a temporary Ecoji Docker container to utilize the CLI:, _(*7)

docker run -it --rm rayne/ecoji --help

Pipe data through a container:, _(*8)

echo -n "Ecoji for Docker" | docker run -i --rm rayne/ecoji
🏣🔉🦐🔼🍉🔹🦒📲🏟🙁🎧🤒💙☕☕☕

Encode or decode a file by mounting it as volume or piping its content through a container:, _(*9)

docker run -it --rm -v /my/message:/file rayne/ecoji /file

cat /my/message | docker run -i --rm rayne/ecoji

Docker Images

The docker/README.md explains how to build the application and all optional development images for all supported PHP versions. Additional convenience scripts run the unit tests with all supported PHP versions., _(*10)

Tests

The library registers the test runner as composer script., _(*11)

composer test

All units tests can also be run in the development containers specified in the docker directory., _(*12)