README

围绕WebpageFX/emoji-cheat-sheet.com表情符号存储库的包装器

安装

此库的安装通过composer进行，所有类的自动加载通过其自动加载器完成。

• 从他们的网站下载composer.phar。
• 然后运行以下命令将此库作为依赖项安装
• php composer.phar require php-extended/php-emoji-cheat-sheet ^7

基本用法

此库只提供了一个类和以下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;
	

此库可以使用以下方式使用

	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;
	

许可证

MIT (见许可证文件)。

待办事项

• 获取Unicode字符的包装器（完整列表在http://unicode.org/emoji/charts/full-emoji-list.html）
• 获取非英语语言的翻译