php-extended / php-emoji-cheat-sheet
A wrapper around the WebpageFX/emoji-cheat-sheet.com emoji repository
5.0.0
2022-12-17 21:42 UTC
Requires
- php: >=7.3
- php-extended/polyfill-php80-stringable: ^1.2
Requires (Dev)
This package is auto-updated.
Last update: 2023-01-17 22:01:52 UTC
README
A wrapper around the WebpageFX/emoji-cheat-sheet.com emoji repository
Installation
The installation of this library is made via composer and the autoloading of all classes of this library is made through their autoloader.
- Download
composer.phar
from their website. - Then run the following command to install this library as dependency :
php composer.phar php-extended/php-emoji-cheat-sheet": "^5"
Basic Usage
This library gives only one class and the following API:
use PhpExtended\EmojiCheatSheet\Emoji;
// method that returns the path on the disk where all the
// emoji images are located.
Emoji::getImagesDirectoryPath():string;
// method that returns an array with all the standard
// emoji (like ":-)") which are to be interpreted as-is
Emoji::getSupportedStandardEmoji():string[];
// method that returns an array with all the extended
// emoji (like "happy") which are to be interpreted in
// a customized wrapper (recommanded : use ":happy:"
// with a ":<name>:" wrapper
Emoji::getSupportedExtendedEmoji():string[];
// method that returns the standardized name of the emoji
// for which we are sure that a file exists
// returns null if there is no known file for given $emoji
Emoji::getImageName(string $emoji):string;
This library may be used the following way:
use PhpExtended\EmojiCheatSheet\Emoji;
$text = '<put the user text with emoji here :happy:>';
$text = htmlentities($text);
foreach(Emoji::getSupportedExtendedEmoji() as $emoji)
{
$replace = '<img src="/path/to/filedir/'.Emoji::getImageName($emoji).'.png" alt="'.$emoji.'">';
$text = str_replace(':'.$emoji.':', $replace, $text);
}
echo $text;
License
MIT (See license file).
TODO
- Get a wrapper for unicode chars (full list at http://unicode.org/emoji/charts/full-emoji-list.html)
- Get a translation for non-english languages