https://github.com/astrotomic/php-twemoji
Easily generate Twemoji URLs
https://github.com/astrotomic/php-twemoji
php treeware twemoji
Last synced: about 1 year ago
JSON representation
Easily generate Twemoji URLs
- Host: GitHub
- URL: https://github.com/astrotomic/php-twemoji
- Owner: Astrotomic
- License: mit
- Created: 2020-10-25T20:26:27.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-11-01T06:51:25.000Z (over 2 years ago)
- Last Synced: 2024-10-29T21:06:02.394Z (over 1 year ago)
- Topics: php, treeware, twemoji
- Language: PHP
- Homepage:
- Size: 62.5 KB
- Stars: 31
- Watchers: 4
- Forks: 13
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PHP Twemoji
[](https://packagist.org/packages/astrotomic/php-twemoji)
[](https://github.com/Astrotomic/php-twemoji/blob/master/LICENSE)
[](https://plant.treeware.earth/Astrotomic/php-twemoji)
[](https://www.larabelles.com/)
[](https://github.com/Astrotomic/php-twemoji/actions?query=workflow%3Arun-tests)
[](https://styleci.io/repos/307185950)
[](https://packagist.org/packages/astrotomic/php-twemoji)
This package provides a fluent PHP OOP builder for [Twemoji](https://twemoji.twitter.com) URLs.
## Installation
You can install the package via composer:
```bash
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.
```php
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.
```php
use Astrotomic\Twemoji\Twemoji;
Twemoji::text("Hello 👋🏿")->toMarkdown();
// Hello 
Twemoji::text("Hello 👋🏿")->png()->toMarkdown();
// Hello 
```
In case you want to configure the replacer once and bind it to your container for example you can do that as well.
```php
use Astrotomic\Twemoji\Replacer;
$replacer = (new Replacer())->png();
$replacer->text("Hello 👋🏿")->toMarkdown();
// Hello 
```
You can also override the replacer configuration for the specific replace operation without altering the replacer configuration.
```php
$replacer->text("Hello 👋🏿")->svg()->toMarkdown();
// Hello 
```
## Testing
```bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/Astrotomic/.github/blob/master/CONTRIBUTING.md) for details. You could also be interested in [CODE OF CONDUCT](https://github.com/Astrotomic/.github/blob/master/CODE_OF_CONDUCT.md).
### Security
If you discover any security related issues, please check [SECURITY](https://github.com/Astrotomic/.github/blob/master/SECURITY.md) for steps to report it.
## Credits
- [Tom Witkowski](https://github.com/Gummibeer)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) 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](https://www.bbc.co.uk/news/science-environment-48870920). 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](https://plant.treeware.earth/Astrotomic/php-twemoji)
Read more about Treeware at [treeware.earth](https://treeware.earth)