Skip to content

Latest commit

 

History

History
59 lines (38 loc) · 1.2 KB

README.md

File metadata and controls

59 lines (38 loc) · 1.2 KB
Raw

LitEmoji 🔥

A PHP library simplifying the conversion of unicode, HTML and shortcode emoji.

Build Status

Installation

$ composer require elvanto/litemoji

Or add to composer.json:

"require": {
    "elvanto/litemoji": "^1.0.0"
}

and then run composer update.

Alternatively you can clone or download the library files.

Usage

use LitEmoji\LitEmoji;

echo LitEmoji::encodeShortcode('Baby you light my 🔥! 😃');
// 'Baby you light my :fire:! :smiley:'

echo LitEmoji::encodeHtml('Baby you light my :fire:! :smiley:');
// 'Baby you light my 🔥! 😃'

echo LitEmoji::encodeUnicode('Baby you light my :fire:! :smiley:');
// 'Baby you light my 🔥! 😃'

Configuration

use LitEmoji\LitEmoji;

// Exclude specific shortcodes when converting from unicode and HTML entities
LitEmoji::config('excludeShortcodes', ['mobile', 'android']);

echo LitEmoji::encodeShortcode('📱');
// ':iphone:'

Contributing

Pull requests are welcome. New code must be fully unit tested (the existing test suite can be run with PHPUnit).

License

MIT License