-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
TextHelper.php
412 lines (379 loc) · 13.6 KB
/
TextHelper.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 0.10.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\View\Helper;
use Cake\Core\App;
use Cake\Core\Exception\Exception;
use Cake\View\Helper;
use Cake\View\View;
/**
* Text helper library.
*
* Text manipulations: Highlight, excerpt, truncate, strip of links, convert email addresses to mailto: links...
*
* @property \Cake\View\Helper\HtmlHelper $Html
* @link https://book.cakephp.org/3.0/en/views/helpers/text.html
* @see \Cake\Utility\Text
*/
class TextHelper extends Helper
{
/**
* helpers
*
* @var array
*/
public $helpers = ['Html'];
/**
* Default config for this class
*
* @var array
*/
protected $_defaultConfig = [
'engine' => 'Cake\Utility\Text'
];
/**
* An array of md5sums and their contents.
* Used when inserting links into text.
*
* @var array
*/
protected $_placeholders = [];
/**
* Cake Utility Text instance
*
* @var \Cake\Utility\Text
*/
protected $_engine;
/**
* Constructor
*
* ### Settings:
*
* - `engine` Class name to use to replace String functionality.
* The class needs to be placed in the `Utility` directory.
*
* @param \Cake\View\View $View the view object the helper is attached to.
* @param array $config Settings array Settings array
* @throws \Cake\Core\Exception\Exception when the engine class could not be found.
*/
public function __construct(View $View, array $config = [])
{
parent::__construct($View, $config);
$config = $this->_config;
$engineClass = App::className($config['engine'], 'Utility');
if ($engineClass) {
$this->_engine = new $engineClass($config);
} else {
throw new Exception(sprintf('Class for %s could not be found', $config['engine']));
}
}
/**
* Call methods from String utility class
*
* @param string $method Method to invoke
* @param array $params Array of params for the method.
* @return mixed Whatever is returned by called method, or false on failure
*/
public function __call($method, $params)
{
return call_user_func_array([$this->_engine, $method], $params);
}
/**
* Adds links (<a href=....) to a given text, by finding text that begins with
* strings like http:// and ftp://.
*
* ### Options
*
* - `escape` Control HTML escaping of input. Defaults to true.
*
* @param string $text Text
* @param array $options Array of HTML options, and options listed above.
* @return string The text with links
* @link https://book.cakephp.org/3.0/en/views/helpers/text.html#linking-urls
*/
public function autoLinkUrls($text, array $options = [])
{
$this->_placeholders = [];
$options += ['escape' => true];
$pattern = '/(?:(?<!href="|src="|">)
(?>
(
(?<left>[\[<(]) # left paren,brace
(?>
# Lax match URL
(?<url>(?:https?|ftp|nntp):\/\/[\p{L}0-9.\-_:]+(?:[\/?][\p{L}0-9.\-_:\/?=&>\[\]\(\)\#\@\+~!;,%]+[^-_:?>\[\(\@\+~!;<,.%\s])?)
(?<right>[\])>]) # right paren,brace
)
)
|
(?<url_bare>(?P>url)) # A bare URL. Use subroutine
)
)/ixu';
$text = preg_replace_callback(
$pattern,
[&$this, '_insertPlaceHolder'],
$text
);
$text = preg_replace_callback(
'#(?<!href="|">)(?<!\b[[:punct:]])(?<!http://|https://|ftp://|nntp://)www\.[^\s\n\%\ <]+[^\s<\n\%\,\.\ <](?<!\))#i',
[&$this, '_insertPlaceHolder'],
$text
);
if ($options['escape']) {
$text = h($text);
}
return $this->_linkUrls($text, $options);
}
/**
* Saves the placeholder for a string, for later use. This gets around double
* escaping content in URL's.
*
* @param array $matches An array of regexp matches.
* @return string Replaced values.
*/
protected function _insertPlaceHolder($matches)
{
$match = $matches[0];
$envelope = ['', ''];
if (isset($matches['url'])) {
$match = $matches['url'];
$envelope = [$matches['left'], $matches['right']];
}
if (isset($matches['url_bare'])) {
$match = $matches['url_bare'];
}
$key = md5($match);
$this->_placeholders[$key] = [
'content' => $match,
'envelope' => $envelope
];
return $key;
}
/**
* Replace placeholders with links.
*
* @param string $text The text to operate on.
* @param array $htmlOptions The options for the generated links.
* @return string The text with links inserted.
*/
protected function _linkUrls($text, $htmlOptions)
{
$replace = [];
foreach ($this->_placeholders as $hash => $content) {
$link = $url = $content['content'];
$envelope = $content['envelope'];
if (!preg_match('#^[a-z]+\://#i', $url)) {
$url = 'http://' . $url;
}
$replace[$hash] = $envelope[0] . $this->Html->link($link, $url, $htmlOptions) . $envelope[1];
}
return strtr($text, $replace);
}
/**
* Links email addresses
*
* @param string $text The text to operate on
* @param array $options An array of options to use for the HTML.
* @return string
* @see \Cake\View\Helper\TextHelper::autoLinkEmails()
*/
protected function _linkEmails($text, $options)
{
$replace = [];
foreach ($this->_placeholders as $hash => $content) {
$url = $content['content'];
$envelope = $content['envelope'];
$replace[$hash] = $envelope[0] . $this->Html->link($url, 'mailto:' . $url, $options) . $envelope[1];
}
return strtr($text, $replace);
}
/**
* Adds email links (<a href="mailto:....) to a given text.
*
* ### Options
*
* - `escape` Control HTML escaping of input. Defaults to true.
*
* @param string $text Text
* @param array $options Array of HTML options, and options listed above.
* @return string The text with links
* @link https://book.cakephp.org/3.0/en/views/helpers/text.html#linking-email-addresses
*/
public function autoLinkEmails($text, array $options = [])
{
$options += ['escape' => true];
$this->_placeholders = [];
$atom = '[\p{L}0-9!#$%&\'*+\/=?^_`{|}~-]';
$text = preg_replace_callback(
'/(?<=\s|^|\(|\>|\;)(' . $atom . '*(?:\.' . $atom . '+)*@[\p{L}0-9-]+(?:\.[\p{L}0-9-]+)+)/ui',
[&$this, '_insertPlaceholder'],
$text
);
if ($options['escape']) {
$text = h($text);
}
return $this->_linkEmails($text, $options);
}
/**
* Convert all links and email addresses to HTML links.
*
* ### Options
*
* - `escape` Control HTML escaping of input. Defaults to true.
*
* @param string $text Text
* @param array $options Array of HTML options, and options listed above.
* @return string The text with links
* @link https://book.cakephp.org/3.0/en/views/helpers/text.html#linking-both-urls-and-email-addresses
*/
public function autoLink($text, array $options = [])
{
$text = $this->autoLinkUrls($text, $options);
return $this->autoLinkEmails($text, ['escape' => false] + $options);
}
/**
* Highlights a given phrase in a text. You can specify any expression in highlighter that
* may include the \1 expression to include the $phrase found.
*
* @param string $text Text to search the phrase in
* @param string $phrase The phrase that will be searched
* @param array $options An array of HTML attributes and options.
* @return string The highlighted text
* @see \Cake\Utility\Text::highlight()
* @link https://book.cakephp.org/3.0/en/views/helpers/text.html#highlighting-substrings
*/
public function highlight($text, $phrase, array $options = [])
{
return $this->_engine->highlight($text, $phrase, $options);
}
/**
* Formats paragraphs around given text for all line breaks
* <br /> added for single line return
* <p> added for double line return
*
* @param string $text Text
* @return string The text with proper <p> and <br /> tags
* @link https://book.cakephp.org/3.0/en/views/helpers/text.html#converting-text-into-paragraphs
*/
public function autoParagraph($text)
{
if (trim($text) !== '') {
$text = preg_replace('|<br[^>]*>\s*<br[^>]*>|i', "\n\n", $text . "\n");
$text = preg_replace("/\n\n+/", "\n\n", str_replace(["\r\n", "\r"], "\n", $text));
$texts = preg_split('/\n\s*\n/', $text, -1, PREG_SPLIT_NO_EMPTY);
$text = '';
foreach ($texts as $txt) {
$text .= '<p>' . nl2br(trim($txt, "\n")) . "</p>\n";
}
$text = preg_replace('|<p>\s*</p>|', '', $text);
}
return $text;
}
/**
* Strips given text of all links (<a href=....)
*
* @param string $text Text
* @return string The text without links
* @see \Cake\Utility\Text::stripLinks()
* @link https://book.cakephp.org/3.0/en/views/helpers/text.html#removing-links
*/
public function stripLinks($text)
{
return $this->_engine->stripLinks($text);
}
/**
* Truncates text.
*
* Cuts a string to the length of $length and replaces the last characters
* with the ellipsis if the text is longer than length.
*
* ### Options:
*
* - `ellipsis` Will be used as Ending and appended to the trimmed string
* - `exact` If false, $text will not be cut mid-word
* - `html` If true, HTML tags would be handled correctly
*
* @param string $text String to truncate.
* @param int $length Length of returned string, including ellipsis.
* @param array $options An array of HTML attributes and options.
* @return string Trimmed string.
* @see \Cake\Utility\Text::truncate()
* @link https://book.cakephp.org/3.0/en/views/helpers/text.html#truncating-text
*/
public function truncate($text, $length = 100, array $options = [])
{
return $this->_engine->truncate($text, $length, $options);
}
/**
* Truncates text starting from the end.
*
* Cuts a string to the length of $length and replaces the first characters
* with the ellipsis if the text is longer than length.
*
* ### Options:
*
* - `ellipsis` Will be used as Beginning and prepended to the trimmed string
* - `exact` If false, $text will not be cut mid-word
*
* @param string $text String to truncate.
* @param int $length Length of returned string, including ellipsis.
* @param array $options An array of HTML attributes and options.
* @return string Trimmed string.
* @see \Cake\Utility\Text::tail()
* @link https://book.cakephp.org/3.0/en/views/helpers/text.html#truncating-the-tail-of-a-string
*/
public function tail($text, $length = 100, array $options = [])
{
return $this->_engine->tail($text, $length, $options);
}
/**
* Extracts an excerpt from the text surrounding the phrase with a number of characters on each side
* determined by radius.
*
* @param string $text String to search the phrase in
* @param string $phrase Phrase that will be searched for
* @param int $radius The amount of characters that will be returned on each side of the founded phrase
* @param string $ending Ending that will be appended
* @return string Modified string
* @see \Cake\Utility\Text::excerpt()
* @link https://book.cakephp.org/3.0/en/views/helpers/text.html#extracting-an-excerpt
*/
public function excerpt($text, $phrase, $radius = 100, $ending = '...')
{
return $this->_engine->excerpt($text, $phrase, $radius, $ending);
}
/**
* Creates a comma separated list where the last two items are joined with 'and', forming natural language.
*
* @param array $list The list to be joined.
* @param string|null $and The word used to join the last and second last items together with. Defaults to 'and'.
* @param string $separator The separator used to join all the other items together. Defaults to ', '.
* @return string The glued together string.
* @see \Cake\Utility\Text::toList()
* @link https://book.cakephp.org/3.0/en/views/helpers/text.html#converting-an-array-to-sentence-form
*/
public function toList($list, $and = null, $separator = ', ')
{
return $this->_engine->toList($list, $and, $separator);
}
/**
* Event listeners.
*
* @return array
*/
public function implementedEvents()
{
return [];
}
}