hidehalo/emoji

filtes emoji symbols for you

1.0.1 2018-03-16 14:06 UTC

Requires (Dev)

• phpunit/phpunit: >=5.7

MIT

• hidehalo

README

If you want help with parse and store emoji symbol characters,you could think about use this library :)

Features

1. Detected emoji symbols only
2. Replace emoji symbols to other texts and turn it back
3. Zero dependence
4. Lightweight and fast

Install

$composer require hidehalo/emoji

Usage

Parser

require vendor/autoload.php;
use Hidehalo\Emoji\Parser;

$parser = new Parser();
$parser->parse($contents);

Converter

# if you want to replace those emoji symbols to ohter marked texts 
# and has ability to turn those back,
# it has a built-in Protocol and Converter could do this
# and $decoded will equals $raw,it is real very simple

use Hidehalo\Emoji\Converter;

$converter = new Converter($parser);
$encoded = $converter->encode($raw);
$decoded = $converter->decode($encoded);

# filter emojis
use Hidehalo\Emoji\Protocol\Filter;

$clean = $converter->encode($raw, new Filter);

Custom protocol

Maybe you want to impl your custom convert protocol,you can make it through implements ProtocolInterface

use Hidehalo\Emoji\Protocol\ProtocolInterface as Protocol;
use Hidehalo\Emoji\Protocol\PatternAwareTrait;

class CustomProto implments Protocol
{
    use PatternAwareTrait;

    protected $format = "FORMAT";
    protected $pattern = "/FORMAT/";

    public function encode($contents)
    {
        //your impls
    }

    public function decode($contents)
    {
        //your impls
    }
}
$customProto = new CustomProto;
$customEncoded = $converter->encode($raw, $customProto);
$customDecoded = $converter->decode($customDecoded, $customProto);

Testing

$./vendor/bin/phpunit

License

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