unicodeveloper/laravel-emoji

A Laravel 5 Package for Using & Working With Emojis

1.0.0 2016-02-08 06:28 UTC

This package is auto-updated.

Last update: 2024-10-07 17:36:28 UTC


README

emoji Latest Stable Version License Build Status Quality Score Total Downloads

A Laravel 5 Package for Using & Working With Emojis in your Laravel Apps

Installation

PHP 7 and Composer are required.

To get the latest version of Laravel Emoji, simply add the following line to the require block of your composer.json file.

"unicodeveloper/laravel-emoji": "1.0.*"

You'll then need to run composer install or composer update to download it and have the autoloader updated.

Once Laravel Emoji is installed, you need to register the service provider. Open up config/app.php and add the following to the providers key.

  • Unicodeveloper\Emoji\EmojiServiceProvider::class

Also, register the Facade like so:

'aliases' => [
    ...
    'Emoji' => Unicodeveloper\Emoji\Facades\Emoji::class,
    ...
]

Usage

Translate Emoji names to Unicode and Vice-versa.

>> Emoji::findByAlias("kissing_heart")
=> "😘"

>> Emoji::findByName("sunglasses")
=> "😎"

>> Emoji::findByUnicode("\u{1F603}")
=> "smiley"

This package contains some of the characters listed on http://unicode.org/emoji/charts/full-emoji-list.html

Contributing

Please feel free to fork this package and contribute by submitting a pull request to enhance the functionalities.

I am accepting PR's that add characters to emoji.php. Please use this list to look up the unicode value and the name of the character.

How can I thank you?

Why not star the github repo? I'd love the attention! Why not share the link for this repository on Twitter or HackerNews? Spread the word!

Don't forget to follow me on twitter!

Thanks! Prosper Otemuyiwa.

Inspiration

License

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