Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maximal/emoji-php
Emoji Detecting and Processing in PHP
https://github.com/maximal/emoji-php
detection detector emoji emoji-searcher emojis php php-lib php-library php7
Last synced: about 1 month ago
JSON representation
Emoji Detecting and Processing in PHP
- Host: GitHub
- URL: https://github.com/maximal/emoji-php
- Owner: maximal
- License: mit
- Created: 2020-01-03T16:09:22.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-04T15:51:48.000Z (over 1 year ago)
- Last Synced: 2024-10-01T18:10:07.191Z (about 1 month ago)
- Topics: detection, detector, emoji, emoji-searcher, emojis, php, php-lib, php-library, php7
- Language: PHP
- Homepage:
- Size: 34.2 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Emoji Detecting and Processing
Unicode version: 15.0.
## Installation
Install this library using the [Composer](https://getcomposer.org) `require` command:
```sh
composer require maximal/emoji '^1.0'
```
or add the package name to the `require` section of your `composer.json` file:
```
"require": {
"maximal/emoji": "^1.0"
}
```
and then run:
```sh
composer update
```
Then include Composer autoload anywhere in your code:
```php
require_once __DIR__ . '/vendor/autoload.php';
```
## Usage
```php
use Maximal\Emoji\Detector;
// Whether the given string contains emoji characters
$isEmojiFound = Detector::containsEmoji($string);
// 'test' -> false
// 'test 👍' -> true
// Whether the given string consists of emoji characters only
$isEmojiOnly = Detector::onlyEmoji($string);
// 'test 👍' -> false
// '👍😘' -> true
// String without any emoji character
$stringWithoutEmoji = Detector::removeEmoji($string);
// 'test 👍' -> 'test '
// '👍😘' -> ''
// All emojis of the string
$allEmojis = Detector::allEmojis($string);
// 'test 👍' -> ['👍']
// '👍😘' -> ['👍', '😘']
// Starting emojis of the string
$startingEmojis = Detector::startingEmojis($string);
// '👍😘 test' -> ['👍', '😘']
// 'test 👍' -> []
```
### `containsEmoji($string): bool`
Detects whether the given string contains one or more emoji characters.
### `onlyEmoji($string, $ignoreWhitespace = true): bool`
Detects whether the given string consists of emoji characters only.
This method ignores any spaces, tabs and other whitespace characters (`\s`).
Pass `false` to the second parameter for not ignoring whitespace characters.
### `removeEmoji($string): string`
Returns the given string with all emoji characters removed.
### `allEmojis($string): array`
Returns an array of all emojis of the input string.
### `startingEmojis($string, $ignoreWhitespace = true): array`
Returns an array of starting emojis of the input string.
This method ignores any spaces, tabs and other whitespace characters (`\s`).
Pass `false` to the second parameter for not ignoring whitespace characters.
## Tests
Run simple tests:
```sh
php test/tests.php
```
Expected output:
```
Tests total: 119
run: 119
succeeded: 119
failed: 0
```
## Contact the author
* Website: https://maximals.ru (Russian)
* Twitter: https://twitter.com/almaximal
* Telegram: https://t.me/maximal
* Sijeko Company: https://sijeko.ru (web, mobile, desktop applications development and graphic design)
* Personal GitHub: https://github.com/maximal
* Company’s GitHub: https://github.com/sijeko