php-twemoji's Introduction

PHP Twemoji

This package provides a fluent PHP OOP builder for Twemoji URLs.

Installation

You can install the package via composer:

composer require astrotomic/php-twemoji

Usage

Single Emojis

You can use the Twemoji::emoji() method to get the Twemoji image URL for a single emoji.

use Astrotomic\Twemoji\Twemoji;

Twemoji::emoji('🎉')->url();
// https://cdn.jsdelivr.net/gh/twitter/twemoji@latest/assets/svg/1f389.svg

Twemoji::emoji('🎉')->png()->url();
// https://cdn.jsdelivr.net/gh/twitter/twemoji@latest/assets/72x72/1f389.png

Twemoji::emoji('🎉')->base('https://twemoji.astrotomic.info')->url();
// https://twemoji.astrotomic.info/svg/1f389.svg

Multiple Emojis in Text

If you have a text and want to replace all emojis with Twemoji image tags (Markdown or HTML) you can use the Twemoji::text() method. This isn't aware of emojis in attributes or anything - it just finds and replaces all Emojis in the given string.

use Astrotomic\Twemoji\Twemoji;

Twemoji::text("Hello 👋🏿")->toMarkdown();
// Hello ![👋🏿](https://cdn.jsdelivr.net/gh/twitter/twemoji@latest/assets/svg/1f44b-1f3ff.svg)

Twemoji::text("Hello 👋🏿")->png()->toMarkdown();
// Hello ![👋🏿](https://cdn.jsdelivr.net/gh/twitter/twemoji@latest/assets/72x72/1f44b-1f3ff.png)

In case you want to configure the replacer once and bind it to your container for example you can do that as well.

use Astrotomic\Twemoji\Replacer;

$replacer = (new Replacer())->png();

$replacer->text("Hello 👋🏿")->toMarkdown();
// Hello ![👋🏿](https://cdn.jsdelivr.net/gh/twitter/twemoji@latest/assets/72x72/1f44b-1f3ff.png)

You can also override the replacer configuration for the specific replace operation without altering the replacer configuration.

$replacer->text("Hello 👋🏿")->svg()->toMarkdown();
// Hello ![👋🏿](https://cdn.jsdelivr.net/gh/twitter/twemoji@latest/assets/1f44b-1f3ff.svg)

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details. You could also be interested in CODE OF CONDUCT.

Security

If you discover any security related issues, please check SECURITY for steps to report it.

Credits

License

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

Treeware

You're free to use this package, but if it makes it to your production environment I would highly appreciate you buying the world a tree.

It’s now common knowledge that one of the best tools to tackle the climate crisis and keep our temperatures from rising above 1.5C is to plant trees. If you contribute to my forest you’ll be creating employment for local families and restoring wildlife habitats.

You can buy trees at offset.earth/treeware

Read more about Treeware at treeware.earth

php-twemoji's People

Contributors

Stargazers

Watchers

php-twemoji's Issues

EmojiText should not be marked as internal

Currently EmojiText is marked as internal with @internal. Since the API of that class is used by consumers of this library it should not be marked as internal.

We noticed our CI was failing on a psalm issue because of this (https://psalm.dev/docs/running_psalm/issues/InternalMethod/).

Add a batch replacer for plain text

In preparation for #2 a method that only parses a given text and replaces ALL emojis in it would be helpful.
This could be used for blogpost content for example or other non HTML texts. And it can be used by the HTML parser to replace all emojis in the content of an HTML tag.

This shouldn'T depend on any library but use PHP regex to find and replace the emojis.

Replace `:+1:` with 👍

After HTML parsing I think that it would be nice to not only replace native emojis but also the common colon emoji-name variants.
I think that the biggest challenge would be getting the list. The spatie/emoji we already use in dev dependencies could provide a good starting point with official names. But a lot of these emojis also have aliases like :+1: and flags also have a shorter name, like :flag-de: or even just :de:.

Add HTML parser/replacer

The original JavaScript Twemoji client allows replacing all emojis in a given text with the corresponding Twemoji image tag in one go.
We should provide a similar method like Twemoji::parse($html) which will search for emojis and replace them.

As this requires a DOM/HTML parser to don't replace emojis in image alternate attributes for example this should be an opt-in feature. SO the DOM library shouldn't be part of the default dependencies but the suggestions.

The method should also be flagged as experimental so everyone knows that it's possible that this method makes trouble.

To test this we should use snapshot testing on some blog posts for example. (could be faked)
They should cover emojis in plain text .txt, in the displayed content of HTML (outside of tags, in tag(s), with body or without) and as part of HTML attributes.

content parser and emoji replacer for:

Text .txt #3
HTML .html
Markdown .md

Recommend Projects

astrotomic / php-twemoji Goto Github PK