Autolink.php
5 years ago
Configuration.php
5 years ago
EmojiRegex.php
5 years ago
Extractor.php
5 years ago
HitHighlighter.php
5 years ago
ParseResults.php
5 years ago
Parser.php
5 years ago
Regex.php
5 years ago
StringUtils.php
5 years ago
TldLists.php
5 years ago
Validator.php
5 years ago
HitHighlighter.php
191 lines
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * @author Nick Pope <nick@nickpope.me.uk> |
| 5 | * @copyright Copyright © 2010, Nick Pope |
| 6 | * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License v2.0 |
| 7 | * @package Twitter.Text |
| 8 | */ |
| 9 | |
| 10 | namespace Twitter\Text; |
| 11 | |
| 12 | /** |
| 13 | * Twitter HitHighlighter Class |
| 14 | * |
| 15 | * Performs "hit highlighting" on tweets that have been auto-linked already. |
| 16 | * Useful with the results returned from the search API. |
| 17 | * |
| 18 | * Originally written by {@link http://github.com/mikenz Mike Cochrane}, this |
| 19 | * is based on code by {@link http://github.com/mzsanford Matt Sanford} and |
| 20 | * heavily modified by {@link http://github.com/ngnpope Nick Pope}. |
| 21 | * |
| 22 | * @author Nick Pope <nick@nickpope.me.uk> |
| 23 | * @copyright Copyright © 2010, Nick Pope |
| 24 | * @license http://www.apache.org/licenses/LICENSE-2.0 Apache License v2.0 |
| 25 | * @package Twitter.Text |
| 26 | */ |
| 27 | class HitHighlighter |
| 28 | { |
| 29 | |
| 30 | /** |
| 31 | * The tag to surround hits with. |
| 32 | * |
| 33 | * @var string |
| 34 | */ |
| 35 | protected $tag = 'em'; |
| 36 | |
| 37 | /** |
| 38 | * The tweet to be used in parsing. |
| 39 | * |
| 40 | * @var string |
| 41 | * @deprecated will be removed |
| 42 | */ |
| 43 | protected $tweet = ''; |
| 44 | |
| 45 | /** |
| 46 | * Provides fluent method chaining. |
| 47 | * |
| 48 | * @param string $tweet [deprecated] The tweet to be hit highlighted. |
| 49 | * @param bool $full_encode [deprecated] Whether to encode all special characters. |
| 50 | * |
| 51 | * @see __construct() |
| 52 | * |
| 53 | * @return HitHighlighter |
| 54 | */ |
| 55 | public static function create($tweet = null, $full_encode = false) |
| 56 | { |
| 57 | return new self($tweet, $full_encode); |
| 58 | } |
| 59 | |
| 60 | /** |
| 61 | * Reads in a tweet to be parsed and hit highlighted. |
| 62 | * |
| 63 | * We take this opportunity to ensure that we escape user input. |
| 64 | * |
| 65 | * @see htmlspecialchars() |
| 66 | * |
| 67 | * @param string $tweet [deprecated] The tweet to be hit highlighted. |
| 68 | * @param bool $escape [deprecated] Whether to escape the tweet (default: true). |
| 69 | * @param bool $full_encode [deprecated] Whether to encode all special characters. |
| 70 | */ |
| 71 | public function __construct($tweet = null, $escape = true, $full_encode = false) |
| 72 | { |
| 73 | if (!empty($tweet) && $escape) { |
| 74 | if ($full_encode) { |
| 75 | $this->tweet = htmlentities($tweet, ENT_QUOTES, 'UTF-8', false); |
| 76 | } else { |
| 77 | $this->tweet = htmlspecialchars($tweet, ENT_QUOTES, 'UTF-8', false); |
| 78 | } |
| 79 | } else { |
| 80 | $this->tweet = $tweet; |
| 81 | } |
| 82 | } |
| 83 | |
| 84 | /** |
| 85 | * Set the highlighting tag to surround hits with. The default tag is 'em'. |
| 86 | * |
| 87 | * @return string The tag name. |
| 88 | */ |
| 89 | public function getTag() |
| 90 | { |
| 91 | return $this->tag; |
| 92 | } |
| 93 | |
| 94 | /** |
| 95 | * Set the highlighting tag to surround hits with. The default tag is 'em'. |
| 96 | * |
| 97 | * @param string $v The tag name. |
| 98 | * |
| 99 | * @return HitHighlighter Fluid method chaining. |
| 100 | */ |
| 101 | public function setTag($v) |
| 102 | { |
| 103 | $this->tag = $v; |
| 104 | return $this; |
| 105 | } |
| 106 | |
| 107 | /** |
| 108 | * Hit highlights the tweet. |
| 109 | * |
| 110 | * @param string $tweet The tweet to be hit highlighted. |
| 111 | * @param array $hits An array containing the start and end index pairs |
| 112 | * for the highlighting. |
| 113 | * |
| 114 | * @return string The hit highlighted tweet. |
| 115 | */ |
| 116 | public function highlight($tweet = null, array $hits = null) |
| 117 | { |
| 118 | if ($tweet === null) { |
| 119 | $tweet = $this->tweet; |
| 120 | } |
| 121 | if (empty($hits)) { |
| 122 | return $tweet; |
| 123 | } |
| 124 | $highlightTweet = ''; |
| 125 | $tags = array('<' . $this->tag . '>', '</' . $this->tag . '>'); |
| 126 | # Check whether we can simply replace or whether we need to chunk... |
| 127 | if (strpos($tweet, '<') === false) { |
| 128 | $ti = 0; // tag increment (for added tags) |
| 129 | $highlightTweet = $tweet; |
| 130 | foreach ($hits as $hit) { |
| 131 | $highlightTweet = StringUtils::substrReplace($highlightTweet, $tags[0], $hit[0] + $ti, 0); |
| 132 | $ti += StringUtils::strlen($tags[0]); |
| 133 | $highlightTweet = StringUtils::substrReplace($highlightTweet, $tags[1], $hit[1] + $ti, 0); |
| 134 | $ti += StringUtils::strlen($tags[1]); |
| 135 | } |
| 136 | } else { |
| 137 | $chunks = preg_split('/[<>]/iu', $tweet); |
| 138 | $chunk = $chunks[0]; |
| 139 | $chunk_index = 0; |
| 140 | $chunk_cursor = 0; |
| 141 | $offset = 0; |
| 142 | $start_in_chunk = false; |
| 143 | # Flatten the multidimensional hits array: |
| 144 | $hits_flat = call_user_func_array('array_merge', array_values($hits)); |
| 145 | $hits_flat_count = count($hits_flat); |
| 146 | # Loop over the hit indices: |
| 147 | for ($index = 0; $index < $hits_flat_count; $index++) { |
| 148 | $hit = $hits_flat[$index]; |
| 149 | $tag = $tags[$index % 2]; |
| 150 | $placed = false; |
| 151 | while ($chunk !== null && $hit >= ($i = $offset + StringUtils::strlen($chunk))) { |
| 152 | $highlightTweet .= StringUtils::substr($chunk, $chunk_cursor); |
| 153 | if ($start_in_chunk && $hit === $i) { |
| 154 | $highlightTweet .= $tag; |
| 155 | $placed = true; |
| 156 | } |
| 157 | if (isset($chunks[$chunk_index + 1])) { |
| 158 | $highlightTweet .= '<' . $chunks[$chunk_index + 1] . '>'; |
| 159 | } |
| 160 | $offset += StringUtils::strlen($chunk); |
| 161 | $chunk_cursor = 0; |
| 162 | $chunk_index += 2; |
| 163 | $chunk = (isset($chunks[$chunk_index]) ? $chunks[$chunk_index] : null); |
| 164 | $start_in_chunk = false; |
| 165 | } |
| 166 | if (!$placed && $chunk !== null) { |
| 167 | $hit_spot = $hit - $offset; |
| 168 | $highlightTweet .= StringUtils::substr($chunk, $chunk_cursor, $hit_spot - $chunk_cursor) . $tag; |
| 169 | $chunk_cursor = $hit_spot; |
| 170 | $start_in_chunk = ($index % 2 === 0); |
| 171 | $placed = true; |
| 172 | } |
| 173 | # Ultimate fallback - hits that run off the end get a closing tag: |
| 174 | if (!$placed) { |
| 175 | $highlightTweet .= $tag; |
| 176 | } |
| 177 | } |
| 178 | if ($chunk !== null) { |
| 179 | if ($chunk_cursor < StringUtils::strlen($chunk)) { |
| 180 | $highlightTweet .= StringUtils::substr($chunk, $chunk_cursor); |
| 181 | } |
| 182 | $chunks_count = count($chunks); |
| 183 | for ($index = $chunk_index + 1; $index < $chunks_count; $index++) { |
| 184 | $highlightTweet .= ($index % 2 === 0 ? $chunks[$index] : '<' . $chunks[$index] . '>'); |
| 185 | } |
| 186 | } |
| 187 | } |
| 188 | return $highlightTweet; |
| 189 | } |
| 190 | } |
| 191 |