ivnkara/telegram-entities-decoder

Telegram entities decoder in PHP

v0.0.3 2023-11-07 12:42 UTC

Requires

• php: >=7.0.0
• ext-dom: *
• ext-mbstring: *

MIT

• LucaDevelop

README

This class decode style entities from Telegram bot messages (bold, italic, etc.) in text with inline entities that duplicate (when possible) the exact style the message had originally when was sended to the bot. All this work is necessary because Telegram returns offset and length of the entities in UTF-16 code units that they've been hard to decode correctly in PHP

Compatibility

PHP >= 7.0

Features

• Decode entities from text messages and attachments caption.
• Supports all Telegram parse modes (Markdown, HTML and MarkdownV2). HTML has more entropy but it's easily the best and it's recommended.
• Supports emoji in the text field
• Easy to use

NOTE: Markdown parse mode is deprecated and no longer up-to-date so it doesn't support all entities. Use MarkdownV2 or HTML.

TODOs

1. Manage Exceptions and wrong inputs
2. Find an easier way to calculate emoji length that not use a regexp or any other way that require to be updated from emoji DB.
3. Right to left writing compatibility

Example usage

$entity_decoder = new EntityDecoder('HTML');
$decoded_text = $entity_decoder->decode($message);

See demo folder for full example

Composer

composer require lucadevelop/telegram-entities-decoder

Usage:

require 'vendor/autoload.php';
use lucadevelop\TelegramEntitiesDecoder\EntityDecoder;
[...]
$entity_decoder = new EntityDecoder('HTML');
$decoded_text = $entity_decoder->decode($message);

Credits

• Telegram docs: https://core.telegram.org/bots/api#formatting-options
• Inspired By: php-telegram-bot/core#544 (comment)
• Emoji detection (with some customizations) from: https://github.com/aaronpk/emoji-detector-php

Contacts

@LucaDevelop