build
5 years ago
lib
5 years ago
Changes.md
5 years ago
LICENSE
5 years ago
README.md
5 years ago
composer.json
5 years ago
README.md
149 lines
| 1 | # Twitter Text (PHP Edition) # |
| 2 | |
| 3 | A library of PHP classes that provide auto-linking and extraction of usernames, |
| 4 | lists, hashtags and URLs from tweets. Originally created from twitter-text-rb |
| 5 | and twitter-text-java projects by Matt Sanford and ported to PHP by Mike |
| 6 | Cochrane, this library has been improved and made more complete by Nick Pope. |
| 7 | |
| 8 | <p align="center"> |
| 9 | <a href="https://github.com/nojimage/twitter-text-php/actions/workflows/ci.yml" target="_blank"> |
| 10 | <img alt="Build Status" src="https://github.com/nojimage/twitter-text-php/actions/workflows/ci.yml/badge.svg"> |
| 11 | </a> |
| 12 | <a href="https://codecov.io/gh/nojimage/twitter-text-php" target="_blank"> |
| 13 | <img alt="Codecov" src="https://img.shields.io/codecov/c/github/nojimage/twitter-text-php.svg?style=flat-square"> |
| 14 | </a> |
| 15 | <a href="https://packagist.org/packages/nojimage/twitter-text-php" target="_blank"> |
| 16 | <img alt="Latest Stable Version" src="https://img.shields.io/packagist/v/nojimage/twitter-text-php.svg?style=flat-square"> |
| 17 | </a> |
| 18 | </p> |
| 19 | |
| 20 | ## Requirements ## |
| 21 | |
| 22 | - PHP 5.3 or higher |
| 23 | - ext-mbstring |
| 24 | - ext-intl |
| 25 | |
| 26 | If the necessary extensions are not installed on the server, please install it additionally or use [](https://github.com/symfony/polyfillsymfony/polyfill](https://github.com/symfony/polyfill](https://github.com/symfony/polyfill). |
| 27 | |
| 28 | ## Install ## |
| 29 | |
| 30 | You can install this library into your application using [](https://getcomposer.org/Composer](https://getcomposer.org/](https://getcomposer.org/). |
| 31 | |
| 32 | ``` |
| 33 | composer require nojimage/twitter-text-php |
| 34 | ``` |
| 35 | |
| 36 | ### Note for Older Server ### |
| 37 | |
| 38 | This library use intl/libICU. |
| 39 | Some older server and PHP 7.2+ combinations may have deprecated warnings due to older ICU versions. [](https://github.com/nojimage/twitter-text-php/issues/32refs #32](https://github.com/nojimage/twitter-text-php/issues/32](https://github.com/nojimage/twitter-text-php/issues/32) |
| 40 | |
| 41 | If you are using RHEL/CentOS 6, installing PHP using [](https://rpms.remirepo.net/the remi repository](https://rpms.remirepo.net/](https://rpms.remirepo.net/) is the best choice. |
| 42 | If you use remi, you can use the new ICU. |
| 43 | |
| 44 | ## Features ## |
| 45 | |
| 46 | ### Autolink ## |
| 47 | |
| 48 | - Add links to all matching Twitter usernames (no account verification). |
| 49 | - Add links to all user lists (of the form @username/list-name). |
| 50 | - Add links to all valid hashtags. |
| 51 | - Add links to all URLs. |
| 52 | - Support for international character sets. |
| 53 | |
| 54 | ### Extractor ### |
| 55 | |
| 56 | - Extract mentioned Twitter usernames (from anywhere in the tweet). |
| 57 | - Extract replied to Twitter usernames (from start of the tweet). |
| 58 | - Extract all user lists (of the form @username/list-name). |
| 59 | - Extract all valid hashtags. |
| 60 | - Extract all URLs. |
| 61 | - Support for international character sets. |
| 62 | |
| 63 | ### Hit Highlighter ### |
| 64 | |
| 65 | - Highlight text specifed by a range by surrounding with a tag. |
| 66 | - Support for highlighting when tweet has already been autolinked. |
| 67 | - Support for international character sets. |
| 68 | |
| 69 | ### Validation ### |
| 70 | |
| 71 | - Validate different twitter text elements. |
| 72 | - Support for international character sets. |
| 73 | |
| 74 | ### Parser ### |
| 75 | |
| 76 | - Parses a given tweet text with the weighted character count configuration. |
| 77 | |
| 78 | ## Length validation ## |
| 79 | |
| 80 | twitter-text 3.0 updates the config file with `emojiParsingEnabled` config option. |
| 81 | When true, twitter-text-php will parse and discount emoji supported by the [](http://www.unicode.org/emoji/charts-11.0Unicode Emoji 11.0](http://www.unicode.org/emoji/charts-11.0](http://www.unicode.org/emoji/charts-11.0) (NOTE: Original [](https://github.com/twitter/twitter-texttwitter-text](https://github.com/twitter/twitter-text](https://github.com/twitter/twitter-text) supported [](https://github.com/twitter/twemojitwemoji library](https://github.com/twitter/twemoji](https://github.com/twitter/twemoji)). |
| 82 | The length of these emoji will be the default weight (200 or two characters) even if they contain multiple code points combined by zero-width joiners. |
| 83 | This means that emoji with skin tone and gender modifiers no longer count as more characters than those without such modifiers. |
| 84 | |
| 85 | twitter-text 2.0 introduced configuration files that define how Tweets are parsed for length. This allows for backwards compatibility and flexibility going forward. |
| 86 | Old-style traditional 140-character parsing is defined by the v1.json configuration file, whereas v2.json is updated for "weighted" Tweets where ranges of Unicode code points can have independent weights aside from the default weight. |
| 87 | The sum of all code points, each weighted appropriately, should not exceed the max weighted length. |
| 88 | |
| 89 | Some old methods from twitter-text-php 1.0 have been marked deprecated, such as the `Twitter\Text\Validator::isValidTweetText()`, `Twitter\Text\Validator::getTweetLength()` method. The new API is based on the following method, `Twitter\Text\Parser::parseTweet()` |
| 90 | |
| 91 | ```(php) |
| 92 | use Twitter\Text\Parser; |
| 93 | $parser = new Parser(); |
| 94 | $result = $parser->parseTweet($text); |
| 95 | ``` |
| 96 | |
| 97 | This method takes a string as input and returns a results object that contains information about the string. `Twitter\Text\ParseResults` object includes: |
| 98 | |
| 99 | - `weightedLength`: the overall length of the tweet with code points |
| 100 | weighted per the ranges defined in the configuration file. |
| 101 | |
| 102 | - `permillage`: indicates the proportion (per thousand) of the weighted |
| 103 | length in comparison to the max weighted length. A value > 1000 |
| 104 | indicates input text that is longer than the allowable maximum. |
| 105 | |
| 106 | - `valid`: indicates if input text length corresponds to a valid |
| 107 | result. |
| 108 | |
| 109 | - `displayRangeStart, displayRangeEnd`: An array of two unicode code point |
| 110 | indices identifying the inclusive start and exclusive end of the |
| 111 | displayable content of the Tweet. For more information, see |
| 112 | the description of `display_text_range` here: |
| 113 | [](https://developer.twitter.com/en/docs/tweets/tweet-updatesTweet updates](https://developer.twitter.com/en/docs/tweets/tweet-updates](https://developer.twitter.com/en/docs/tweets/tweet-updates) |
| 114 | |
| 115 | - `validRangeStart, validRangeRnd`: An array of two unicode code point |
| 116 | indices identifying the inclusive start and exclusive end of the valid |
| 117 | content of the Tweet. For more information on the extended Tweet |
| 118 | payload see [](https://developer.twitter.com/en/docs/tweets/tweet-updatesTweet updates](https://developer.twitter.com/en/docs/tweets/tweet-updates](https://developer.twitter.com/en/docs/tweets/tweet-updates) |
| 119 | |
| 120 | ## Examples ## |
| 121 | |
| 122 | For examples, please see `tests/example.php` which you can view in a browser or |
| 123 | run from the command line. |
| 124 | |
| 125 | ## Conformance ## |
| 126 | |
| 127 | You'll need the test data which is in YAML format from the following |
| 128 | repository: |
| 129 | |
| 130 | https://github.com/twitter/twitter-text |
| 131 | |
| 132 | `twitter/twitter-text` already included in `composer.json`, so you should just need to run: |
| 133 | |
| 134 | curl -s https://getcomposer.org/installer | php |
| 135 | php composer.phar install |
| 136 | |
| 137 | There are a couple of options for testing conformance: |
| 138 | |
| 139 | - Run `phpunit` in from the root folder of the project. |
| 140 | |
| 141 | ## Thanks & Contributions ## |
| 142 | |
| 143 | The bulk of this library is from the heroic efforts of: |
| 144 | |
| 145 | - Matt Sanford (https://github.com/mzsanford): For the orignal Ruby and Java implementions. |
| 146 | - Mike Cochrane (https://github.com/mikenz): For the initial PHP code. |
| 147 | - Nick Pope (https://github.com/ngnpope): For the bulk of the maintenance work to date. |
| 148 | - Takashi Nojima (https://github.com/nojimage): For ongoing maintenance work. |
| 149 |