Passed
Push — master ( 831065...bd113f )
by Martijn
01:58
created
src/Sentence.php 2 patches
Spacing   +2 added lines, -2 removed lines patch added patch discarded remove patch
@@ -121,7 +121,7 @@  discard block
 block discarded – undo
121 121
         $merges = [];
122 122
         $merge = '';
123 123
 
124
-        $filtered = array_filter($punctuations, function ($p) {
124
+        $filtered = array_filter($punctuations, function($p) {
125 125
             return $p !== '';
126 126
         });
127 127
 
@@ -366,7 +366,7 @@  discard block
 block discarded – undo
366 366
      */
367 367
     private static function trimSentences($sentences)
368 368
     {
369
-        return array_map(function ($sentence) {
369
+        return array_map(function($sentence) {
370 370
             return Multibyte::trim($sentence);
371 371
         }, $sentences);
372 372
     }
Please login to merge, or discard this patch.
Indentation   +414 added lines, -414 removed lines patch added patch discarded remove patch
@@ -17,419 +17,419 @@
 block discarded – undo
17 17
 class Sentence
18 18
 {
19 19
 
20
-    /**
21
-     * Specify this flag with the split method to trim whitespace.
22
-     */
23
-    const SPLIT_TRIM = 0x1;
24
-
25
-    /**
26
-     * List of characters used to terminate sentences.
27
-     *
28
-     * @var string[]
29
-     */
30
-    private $terminals = ['.', '!', '?'];
31
-
32
-    /**
33
-     * List of characters used for abbreviations.
34
-     *
35
-     * @var string[]
36
-     */
37
-    private $abbreviators = ['.'];
38
-
39
-    /**
40
-     * List of float numbers in the text
41
-     *
42
-     * @var string[]
43
-     */
44
-    private $floatNumbers = [];
45
-
46
-    /**
47
-     * Clean floating point numbers by replace them with their md5 hash
48
-     *
49
-     * @param string $text
50
-     *
51
-     * @return string
52
-     */
53
-    private function floatNumberClean(string $text)
54
-    {
55
-        preg_match_all('!\d+(?:\.\d+)?!', $text, $matches);
56
-
57
-        $this->floatNumbers = [];
58
-        foreach ($matches[0] as $floatNumber) {
59
-            if (isset($this->floatNumbers[$floatNumber])) {
60
-                continue;
61
-            }
62
-
63
-            $hash = md5($floatNumber);
64
-            $this->floatNumbers[$floatNumber] = $hash;
65
-            $text = str_replace($floatNumber, $hash, $text);
66
-        }
67
-
68
-        return $text;
69
-    }
70
-
71
-    /**
72
-     * Revert the hashed floating number back
73
-     *
74
-     * @param string[] $text
75
-     *
76
-     * @return string[]
77
-     */
78
-    private function floatNumberRevert($text)
79
-    {
80
-        return array_map(function($value) {
81
-            foreach ($this->floatNumbers as $number => $hash) {
82
-                $value = str_replace($hash, $number, $value);
83
-            }
84
-            return $value;
85
-        }, $text);
86
-    }
87
-
88
-    /**
89
-     * Breaks a piece of text into lines by linebreak.
90
-     * Eats up any linebreak characters as if one.
91
-     *
92
-     * Multibyte.php safe
93
-     *
94
-     * @param string $text
95
-     * @return string[]
96
-     */
97
-    private static function linebreakSplit($text)
98
-    {
99
-        $lines = [];
100
-        $line = '';
101
-
102
-        foreach (Multibyte::split('([\r\n]+)', $text, -1, PREG_SPLIT_DELIM_CAPTURE) as $part) {
103
-            $line .= $part;
104
-            if (Multibyte::trim($part) === '') {
105
-                $lines[] = $line;
106
-                $line = '';
107
-            }
108
-        }
109
-        $lines[] = $line;
110
-
111
-        return $lines;
112
-    }
113
-
114
-    /**
115
-     * Splits an array of lines by (consecutive sequences of)
116
-     * terminals, keeping terminals.
117
-     *
118
-     * Multibyte.php safe (atleast for UTF-8)
119
-     *
120
-     * For example:
121
-     *    "There ... is. More!"
122
-     *        ... becomes ...
123
-     *    [ "There ", "...", " is", ".", " More", "!" ]
124
-     *
125
-     * @param string $line
126
-     * @return string[]
127
-     */
128
-    private function punctuationSplit($line)
129
-    {
130
-        $parts = [];
131
-
132
-        $chars = preg_split('//u', $line, -1, PREG_SPLIT_NO_EMPTY); // This is UTF8 multibyte safe!
133
-        $is_terminal = in_array($chars[0], $this->terminals);
134
-
135
-        $part = '';
136
-        foreach ($chars as $index => $char) {
137
-            if (in_array($char, $this->terminals) !== $is_terminal) {
138
-                $parts[] = $part;
139
-                $part = '';
140
-                $is_terminal = !$is_terminal;
141
-            }
142
-            $part .= $char;
143
-        }
144
-
145
-        if (!empty($part)) {
146
-            $parts[] = $part;
147
-        }
148
-
149
-        return $parts;
150
-    }
151
-
152
-    /**
153
-     * Appends each terminal item after it's preceding
154
-     * non-terminals.
155
-     *
156
-     * Multibyte.php safe (atleast for UTF-8)
157
-     *
158
-     * For example:
159
-     *    [ "There ", "...", " is", ".", " More", "!" ]
160
-     *        ... becomes ...
161
-     *    [ "There ... is.", "More!" ]
162
-     *
163
-     * @param string[] $punctuations
164
-     * @return string[]
165
-     */
166
-    private function punctuationMerge($punctuations)
167
-    {
168
-        $definite_terminals = array_diff($this->terminals, $this->abbreviators);
169
-
170
-        $merges = [];
171
-        $merge = '';
172
-
173
-        $filtered = array_filter($punctuations, function ($p) {
174
-            return $p !== '';
175
-        });
176
-
177
-        foreach ($filtered as $punctuation) {
178
-            $merge .= $punctuation;
179
-            if (mb_strlen($punctuation) === 1
180
-                && in_array($punctuation, $this->terminals)) {
181
-                $merges[] = $merge;
182
-                $merge = '';
183
-            } else {
184
-                foreach ($definite_terminals as $terminal) {
185
-                    if (mb_strpos($punctuation, $terminal) !== false) {
186
-                        $merges[] = $merge;
187
-                        $merge = '';
188
-                        break;
189
-                    }
190
-                }
191
-            }
192
-        }
193
-        if (!empty($merge)) {
194
-            $merges[] = $merge;
195
-        }
196
-
197
-        return $merges;
198
-    }
199
-
200
-    /**
201
-     * Looks for capitalized abbreviations & includes them with the following fragment.
202
-     *
203
-     * For example:
204
-     *    [ "Last week, former director of the F.B.I. James B. Comey was fired. Mr. Comey was not available for comment." ]
205
-     *        ... becomes ...
206
-     *    [ "Last week, former director of the F.B.I. James B. Comey was fired." ]
207
-     *  [ "Mr. Comey was not available for comment." ]
208
-     *
209
-     * @param string[] $fragments
210
-     * @return string[]
211
-     */
212
-    private function abbreviationMerge($fragments)
213
-    {
214
-        $return_fragment = [];
215
-
216
-        $previous_fragment = '';
217
-        $previous_is_abbreviation = false;
218
-        $i = 0;
219
-        foreach ($fragments as $fragment) {
220
-            $is_abbreviation = self::isAbreviation($fragment);
221
-
222
-            // merge previous fragment with this
223
-            if ($previous_is_abbreviation) {
224
-                $fragment = $previous_fragment . $fragment;
225
-            }
226
-            $return_fragment[$i] = $fragment;
227
-
228
-            $previous_is_abbreviation = $is_abbreviation;
229
-            $previous_fragment = $fragment;
230
-
231
-            // only increment if this isn't an abbreviation
232
-            if (!$is_abbreviation) {
233
-                $i++;
234
-            }
235
-        }
236
-        return $return_fragment;
237
-    }
238
-
239
-    /**
240
-     * Check if the last word of fragment starts with a Capital, ends in "." & has less than 3 characters.
241
-     *
242
-     * @param $fragment
243
-     * @return bool
244
-     */
245
-    private static function isAbreviation($fragment)
246
-    {
247
-        $words = mb_split('\s+', Multibyte::trim($fragment));
248
-
249
-        $word_count = count($words);
250
-
251
-        $last_word = Multibyte::trim($words[$word_count - 1]);
252
-        $last_is_capital = preg_match('#^\p{Lu}#u', $last_word);
253
-        $last_is_abbreviation = mb_substr(Multibyte::trim($fragment), -1) === '.';
254
-
255
-        return $last_is_capital > 0
256
-            && $last_is_abbreviation > 0
257
-            && mb_strlen($last_word) <= 3;
258
-    }
259
-
260
-    /**
261
-     * Merges any part starting with a closing parenthesis ')' to the previous
262
-     * part.
263
-     *
264
-     * @param string[] $parts
265
-     * @return string[]
266
-     */
267
-    private function parenthesesMerge($parts)
268
-    {
269
-        $subsentences = [];
270
-
271
-        foreach ($parts as $part) {
272
-            if ($part[0] === ')') {
273
-                $subsentences[count($subsentences) - 1] .= $part;
274
-            } else {
275
-                $subsentences[] = $part;
276
-            }
277
-        }
278
-
279
-        return $subsentences;
280
-    }
281
-
282
-    /**
283
-     * Looks for closing quotes to include them with the previous statement.
284
-     * "That was very interesting," he said.
285
-     * "That was very interesting."
286
-     *
287
-     * @param string[] $statements
288
-     * @return string[]
289
-     */
290
-    private function closeQuotesMerge($statements)
291
-    {
292
-        $i = 0;
293
-        $previous_statement = '';
294
-        $return = [];
295
-        foreach ($statements as $statement) {
296
-            if (self::isEndQuote($statement)) {
297
-                $statement = $previous_statement . $statement;
298
-            } else {
299
-                $i++;
300
-            }
301
-
302
-            $return[$i] = $statement;
303
-            $previous_statement = $statement;
304
-        }
305
-
306
-        return $return;
307
-    }
308
-
309
-    /**
310
-     * Check if the entire string is a quotation mark or quote, then space, then lowercase.
311
-     *
312
-     * @param $statement
313
-     * @return bool
314
-     */
315
-    private static function isEndQuote($statement)
316
-    {
317
-        $trimmed = Multibyte::trim($statement);
318
-        $first = mb_substr($statement, 0, 1);
319
-
320
-        return in_array($trimmed, ['"', '\''])
321
-            || (
322
-                in_array($first, ['"', '\''])
323
-                && mb_substr($statement, 1, 1) === ' '
324
-                && ctype_lower(mb_substr($statement, 2, 1)) === true
325
-            );
326
-    }
327
-
328
-    /**
329
-     * Merges items into larger sentences.
330
-     * Multibyte.php safe
331
-     *
332
-     * @param string[] $shorts
333
-     * @return string[]
334
-     */
335
-    private function sentenceMerge($shorts)
336
-    {
337
-        $non_abbreviating_terminals = array_diff($this->terminals, $this->abbreviators);
338
-
339
-        $sentences = [];
340
-
341
-        $sentence = '';
342
-        $has_words = false;
343
-        $previous_word_ending = null;
344
-        foreach ($shorts as $short) {
345
-            $word_count = count(mb_split('\s+', Multibyte::trim($short)));
346
-            $after_non_abbreviating_terminal = in_array($previous_word_ending, $non_abbreviating_terminals);
347
-
348
-            if ($after_non_abbreviating_terminal
349
-                || ($has_words && $word_count > 1)) {
350
-
351
-                $sentences[] = $sentence;
352
-
353
-                $sentence = '';
354
-                $has_words = false;
355
-            }
356
-
357
-            $has_words = $has_words
358
-                || $word_count > 1;
359
-
360
-            $sentence .= $short;
361
-            $previous_word_ending = mb_substr($short, -1);
362
-        }
363
-
364
-        if (!empty($sentence)) {
365
-            $sentences[] = $sentence;
366
-        }
367
-
368
-        return $sentences;
369
-    }
370
-
371
-    /**
372
-     * Return the sentences sentences detected in the provided text.
373
-     * Set the Sentence::SPLIT_TRIM flag to trim whitespace.
374
-     * @param string $text
375
-     * @param integer $flags
376
-     * @return string[]
377
-     */
378
-    public function split($text, $flags = 0)
379
-    {
380
-        static $pipeline = [
381
-            'floatNumberClean',
382
-            'punctuationSplit',
383
-            'parenthesesMerge', // also works after punctuationMerge or abbreviationMerge
384
-            'punctuationMerge',
385
-            'abbreviationMerge',
386
-            'closeQuotesMerge',
387
-            'sentenceMerge',
388
-            'floatNumberRevert'
389
-        ];
390
-
391
-        // clean funny quotes
392
-        $text = Multibyte::cleanUnicode($text);
393
-
394
-        // Split
395
-        $sentences = [];
396
-        foreach (self::linebreakSplit($text) as $input) {
397
-            if (Multibyte::trim($input) !== '') {
398
-                foreach ($pipeline as $method) {
399
-                    $input = $this->$method($input);
400
-                }
401
-                $sentences = array_merge($sentences, $input);
402
-            }
403
-        }
404
-
405
-        // Post process
406
-        if ($flags & self::SPLIT_TRIM) {
407
-            return self::trimSentences($sentences);
408
-        }
409
-
410
-        return $sentences;
411
-    }
412
-
413
-    /**
414
-     * Multibyte.php trim each string in an array.
415
-     * @param string[] $sentences
416
-     * @return string[]
417
-     */
418
-    private static function trimSentences($sentences)
419
-    {
420
-        return array_map(function ($sentence) {
421
-            return Multibyte::trim($sentence);
422
-        }, $sentences);
423
-    }
424
-
425
-    /**
426
-     * Return the number of sentences detected in the provided text.
427
-     * @param string $text
428
-     * @return integer
429
-     */
430
-    public function count($text)
431
-    {
432
-        return count($this->split($text));
433
-    }
20
+	/**
21
+	 * Specify this flag with the split method to trim whitespace.
22
+	 */
23
+	const SPLIT_TRIM = 0x1;
24
+
25
+	/**
26
+	 * List of characters used to terminate sentences.
27
+	 *
28
+	 * @var string[]
29
+	 */
30
+	private $terminals = ['.', '!', '?'];
31
+
32
+	/**
33
+	 * List of characters used for abbreviations.
34
+	 *
35
+	 * @var string[]
36
+	 */
37
+	private $abbreviators = ['.'];
38
+
39
+	/**
40
+	 * List of float numbers in the text
41
+	 *
42
+	 * @var string[]
43
+	 */
44
+	private $floatNumbers = [];
45
+
46
+	/**
47
+	 * Clean floating point numbers by replace them with their md5 hash
48
+	 *
49
+	 * @param string $text
50
+	 *
51
+	 * @return string
52
+	 */
53
+	private function floatNumberClean(string $text)
54
+	{
55
+		preg_match_all('!\d+(?:\.\d+)?!', $text, $matches);
56
+
57
+		$this->floatNumbers = [];
58
+		foreach ($matches[0] as $floatNumber) {
59
+			if (isset($this->floatNumbers[$floatNumber])) {
60
+				continue;
61
+			}
62
+
63
+			$hash = md5($floatNumber);
64
+			$this->floatNumbers[$floatNumber] = $hash;
65
+			$text = str_replace($floatNumber, $hash, $text);
66
+		}
67
+
68
+		return $text;
69
+	}
70
+
71
+	/**
72
+	 * Revert the hashed floating number back
73
+	 *
74
+	 * @param string[] $text
75
+	 *
76
+	 * @return string[]
77
+	 */
78
+	private function floatNumberRevert($text)
79
+	{
80
+		return array_map(function($value) {
81
+			foreach ($this->floatNumbers as $number => $hash) {
82
+				$value = str_replace($hash, $number, $value);
83
+			}
84
+			return $value;
85
+		}, $text);
86
+	}
87
+
88
+	/**
89
+	 * Breaks a piece of text into lines by linebreak.
90
+	 * Eats up any linebreak characters as if one.
91
+	 *
92
+	 * Multibyte.php safe
93
+	 *
94
+	 * @param string $text
95
+	 * @return string[]
96
+	 */
97
+	private static function linebreakSplit($text)
98
+	{
99
+		$lines = [];
100
+		$line = '';
101
+
102
+		foreach (Multibyte::split('([\r\n]+)', $text, -1, PREG_SPLIT_DELIM_CAPTURE) as $part) {
103
+			$line .= $part;
104
+			if (Multibyte::trim($part) === '') {
105
+				$lines[] = $line;
106
+				$line = '';
107
+			}
108
+		}
109
+		$lines[] = $line;
110
+
111
+		return $lines;
112
+	}
113
+
114
+	/**
115
+	 * Splits an array of lines by (consecutive sequences of)
116
+	 * terminals, keeping terminals.
117
+	 *
118
+	 * Multibyte.php safe (atleast for UTF-8)
119
+	 *
120
+	 * For example:
121
+	 *    "There ... is. More!"
122
+	 *        ... becomes ...
123
+	 *    [ "There ", "...", " is", ".", " More", "!" ]
124
+	 *
125
+	 * @param string $line
126
+	 * @return string[]
127
+	 */
128
+	private function punctuationSplit($line)
129
+	{
130
+		$parts = [];
131
+
132
+		$chars = preg_split('//u', $line, -1, PREG_SPLIT_NO_EMPTY); // This is UTF8 multibyte safe!
133
+		$is_terminal = in_array($chars[0], $this->terminals);
134
+
135
+		$part = '';
136
+		foreach ($chars as $index => $char) {
137
+			if (in_array($char, $this->terminals) !== $is_terminal) {
138
+				$parts[] = $part;
139
+				$part = '';
140
+				$is_terminal = !$is_terminal;
141
+			}
142
+			$part .= $char;
143
+		}
144
+
145
+		if (!empty($part)) {
146
+			$parts[] = $part;
147
+		}
148
+
149
+		return $parts;
150
+	}
151
+
152
+	/**
153
+	 * Appends each terminal item after it's preceding
154
+	 * non-terminals.
155
+	 *
156
+	 * Multibyte.php safe (atleast for UTF-8)
157
+	 *
158
+	 * For example:
159
+	 *    [ "There ", "...", " is", ".", " More", "!" ]
160
+	 *        ... becomes ...
161
+	 *    [ "There ... is.", "More!" ]
162
+	 *
163
+	 * @param string[] $punctuations
164
+	 * @return string[]
165
+	 */
166
+	private function punctuationMerge($punctuations)
167
+	{
168
+		$definite_terminals = array_diff($this->terminals, $this->abbreviators);
169
+
170
+		$merges = [];
171
+		$merge = '';
172
+
173
+		$filtered = array_filter($punctuations, function ($p) {
174
+			return $p !== '';
175
+		});
176
+
177
+		foreach ($filtered as $punctuation) {
178
+			$merge .= $punctuation;
179
+			if (mb_strlen($punctuation) === 1
180
+				&& in_array($punctuation, $this->terminals)) {
181
+				$merges[] = $merge;
182
+				$merge = '';
183
+			} else {
184
+				foreach ($definite_terminals as $terminal) {
185
+					if (mb_strpos($punctuation, $terminal) !== false) {
186
+						$merges[] = $merge;
187
+						$merge = '';
188
+						break;
189
+					}
190
+				}
191
+			}
192
+		}
193
+		if (!empty($merge)) {
194
+			$merges[] = $merge;
195
+		}
196
+
197
+		return $merges;
198
+	}
199
+
200
+	/**
201
+	 * Looks for capitalized abbreviations & includes them with the following fragment.
202
+	 *
203
+	 * For example:
204
+	 *    [ "Last week, former director of the F.B.I. James B. Comey was fired. Mr. Comey was not available for comment." ]
205
+	 *        ... becomes ...
206
+	 *    [ "Last week, former director of the F.B.I. James B. Comey was fired." ]
207
+	 *  [ "Mr. Comey was not available for comment." ]
208
+	 *
209
+	 * @param string[] $fragments
210
+	 * @return string[]
211
+	 */
212
+	private function abbreviationMerge($fragments)
213
+	{
214
+		$return_fragment = [];
215
+
216
+		$previous_fragment = '';
217
+		$previous_is_abbreviation = false;
218
+		$i = 0;
219
+		foreach ($fragments as $fragment) {
220
+			$is_abbreviation = self::isAbreviation($fragment);
221
+
222
+			// merge previous fragment with this
223
+			if ($previous_is_abbreviation) {
224
+				$fragment = $previous_fragment . $fragment;
225
+			}
226
+			$return_fragment[$i] = $fragment;
227
+
228
+			$previous_is_abbreviation = $is_abbreviation;
229
+			$previous_fragment = $fragment;
230
+
231
+			// only increment if this isn't an abbreviation
232
+			if (!$is_abbreviation) {
233
+				$i++;
234
+			}
235
+		}
236
+		return $return_fragment;
237
+	}
238
+
239
+	/**
240
+	 * Check if the last word of fragment starts with a Capital, ends in "." & has less than 3 characters.
241
+	 *
242
+	 * @param $fragment
243
+	 * @return bool
244
+	 */
245
+	private static function isAbreviation($fragment)
246
+	{
247
+		$words = mb_split('\s+', Multibyte::trim($fragment));
248
+
249
+		$word_count = count($words);
250
+
251
+		$last_word = Multibyte::trim($words[$word_count - 1]);
252
+		$last_is_capital = preg_match('#^\p{Lu}#u', $last_word);
253
+		$last_is_abbreviation = mb_substr(Multibyte::trim($fragment), -1) === '.';
254
+
255
+		return $last_is_capital > 0
256
+			&& $last_is_abbreviation > 0
257
+			&& mb_strlen($last_word) <= 3;
258
+	}
259
+
260
+	/**
261
+	 * Merges any part starting with a closing parenthesis ')' to the previous
262
+	 * part.
263
+	 *
264
+	 * @param string[] $parts
265
+	 * @return string[]
266
+	 */
267
+	private function parenthesesMerge($parts)
268
+	{
269
+		$subsentences = [];
270
+
271
+		foreach ($parts as $part) {
272
+			if ($part[0] === ')') {
273
+				$subsentences[count($subsentences) - 1] .= $part;
274
+			} else {
275
+				$subsentences[] = $part;
276
+			}
277
+		}
278
+
279
+		return $subsentences;
280
+	}
281
+
282
+	/**
283
+	 * Looks for closing quotes to include them with the previous statement.
284
+	 * "That was very interesting," he said.
285
+	 * "That was very interesting."
286
+	 *
287
+	 * @param string[] $statements
288
+	 * @return string[]
289
+	 */
290
+	private function closeQuotesMerge($statements)
291
+	{
292
+		$i = 0;
293
+		$previous_statement = '';
294
+		$return = [];
295
+		foreach ($statements as $statement) {
296
+			if (self::isEndQuote($statement)) {
297
+				$statement = $previous_statement . $statement;
298
+			} else {
299
+				$i++;
300
+			}
301
+
302
+			$return[$i] = $statement;
303
+			$previous_statement = $statement;
304
+		}
305
+
306
+		return $return;
307
+	}
308
+
309
+	/**
310
+	 * Check if the entire string is a quotation mark or quote, then space, then lowercase.
311
+	 *
312
+	 * @param $statement
313
+	 * @return bool
314
+	 */
315
+	private static function isEndQuote($statement)
316
+	{
317
+		$trimmed = Multibyte::trim($statement);
318
+		$first = mb_substr($statement, 0, 1);
319
+
320
+		return in_array($trimmed, ['"', '\''])
321
+			|| (
322
+				in_array($first, ['"', '\''])
323
+				&& mb_substr($statement, 1, 1) === ' '
324
+				&& ctype_lower(mb_substr($statement, 2, 1)) === true
325
+			);
326
+	}
327
+
328
+	/**
329
+	 * Merges items into larger sentences.
330
+	 * Multibyte.php safe
331
+	 *
332
+	 * @param string[] $shorts
333
+	 * @return string[]
334
+	 */
335
+	private function sentenceMerge($shorts)
336
+	{
337
+		$non_abbreviating_terminals = array_diff($this->terminals, $this->abbreviators);
338
+
339
+		$sentences = [];
340
+
341
+		$sentence = '';
342
+		$has_words = false;
343
+		$previous_word_ending = null;
344
+		foreach ($shorts as $short) {
345
+			$word_count = count(mb_split('\s+', Multibyte::trim($short)));
346
+			$after_non_abbreviating_terminal = in_array($previous_word_ending, $non_abbreviating_terminals);
347
+
348
+			if ($after_non_abbreviating_terminal
349
+				|| ($has_words && $word_count > 1)) {
350
+
351
+				$sentences[] = $sentence;
352
+
353
+				$sentence = '';
354
+				$has_words = false;
355
+			}
356
+
357
+			$has_words = $has_words
358
+				|| $word_count > 1;
359
+
360
+			$sentence .= $short;
361
+			$previous_word_ending = mb_substr($short, -1);
362
+		}
363
+
364
+		if (!empty($sentence)) {
365
+			$sentences[] = $sentence;
366
+		}
367
+
368
+		return $sentences;
369
+	}
370
+
371
+	/**
372
+	 * Return the sentences sentences detected in the provided text.
373
+	 * Set the Sentence::SPLIT_TRIM flag to trim whitespace.
374
+	 * @param string $text
375
+	 * @param integer $flags
376
+	 * @return string[]
377
+	 */
378
+	public function split($text, $flags = 0)
379
+	{
380
+		static $pipeline = [
381
+			'floatNumberClean',
382
+			'punctuationSplit',
383
+			'parenthesesMerge', // also works after punctuationMerge or abbreviationMerge
384
+			'punctuationMerge',
385
+			'abbreviationMerge',
386
+			'closeQuotesMerge',
387
+			'sentenceMerge',
388
+			'floatNumberRevert'
389
+		];
390
+
391
+		// clean funny quotes
392
+		$text = Multibyte::cleanUnicode($text);
393
+
394
+		// Split
395
+		$sentences = [];
396
+		foreach (self::linebreakSplit($text) as $input) {
397
+			if (Multibyte::trim($input) !== '') {
398
+				foreach ($pipeline as $method) {
399
+					$input = $this->$method($input);
400
+				}
401
+				$sentences = array_merge($sentences, $input);
402
+			}
403
+		}
404
+
405
+		// Post process
406
+		if ($flags & self::SPLIT_TRIM) {
407
+			return self::trimSentences($sentences);
408
+		}
409
+
410
+		return $sentences;
411
+	}
412
+
413
+	/**
414
+	 * Multibyte.php trim each string in an array.
415
+	 * @param string[] $sentences
416
+	 * @return string[]
417
+	 */
418
+	private static function trimSentences($sentences)
419
+	{
420
+		return array_map(function ($sentence) {
421
+			return Multibyte::trim($sentence);
422
+		}, $sentences);
423
+	}
424
+
425
+	/**
426
+	 * Return the number of sentences detected in the provided text.
427
+	 * @param string $text
428
+	 * @return integer
429
+	 */
430
+	public function count($text)
431
+	{
432
+		return count($this->split($text));
433
+	}
434 434
 
435 435
 }
Please login to merge, or discard this patch.
src/Multibyte.php 2 patches
Indentation   +173 added lines, -173 removed lines patch added patch discarded remove patch
@@ -7,177 +7,177 @@
 block discarded – undo
7 7
  */
8 8
 class Multibyte
9 9
 {
10
-    //https://stackoverflow.com/questions/20025030/convert-all-types-of-smart-quotes-with-php
11
-    private static $unicodeCharacterMap = [
12
-        // Windows codepage 1252
13
-        "\xC2\x82" => "'", // U+0082⇒U+201A single low-9 quotation mark
14
-        "\xC2\x84" => '"', // U+0084⇒U+201E double low-9 quotation mark
15
-        "\xC2\x8B" => "'", // U+008B⇒U+2039 single left-pointing angle quotation mark
16
-        "\xC2\x91" => "'", // U+0091⇒U+2018 left single quotation mark
17
-        "\xC2\x92" => "'", // U+0092⇒U+2019 right single quotation mark
18
-        "\xC2\x93" => '"', // U+0093⇒U+201C left double quotation mark
19
-        "\xC2\x94" => '"', // U+0094⇒U+201D right double quotation mark
20
-        "\xC2\x9B" => "'", // U+009B⇒U+203A single right-pointing angle quotation mark
21
-        // Regular Unicode     // U+0022 quotation mark (")
22
-        // U+0027 apostrophe     (')
23
-        "\xC2\xAB" => '"', // U+00AB left-pointing double angle quotation mark
24
-        "\xC2\xBB" => '"', // U+00BB right-pointing double angle quotation mark
25
-        "\xE2\x80\x98" => "'", // U+2018 left single quotation mark
26
-        "\xE2\x80\x99" => "'", // U+2019 right single quotation mark
27
-        "\xE2\x80\x9A" => "'", // U+201A single low-9 quotation mark
28
-        "\xE2\x80\x9B" => "'", // U+201B single high-reversed-9 quotation mark
29
-        "\xE2\x80\x9C" => '"', // U+201C left double quotation mark
30
-        "\xE2\x80\x9D" => '"', // U+201D right double quotation mark
31
-        "\xE2\x80\x9E" => '"', // U+201E double low-9 quotation mark
32
-        "\xE2\x80\x9F" => '"', // U+201F double high-reversed-9 quotation mark
33
-        "\xE2\x80\xB9" => "'", // U+2039 single left-pointing angle quotation mark
34
-        "\xE2\x80\xBA" => "'", // U+203A single right-pointing angle quotation mark
35
-    ];
36
-
37
-    /**
38
-     * Replace
39
-     *
40
-     * @staticvar array $chr_map
41
-     * @param string $string
42
-     * @return string
43
-     */
44
-    public static function cleanUnicode($string)
45
-    {
46
-        $character = array_keys(self::$unicodeCharacterMap); // but: for efficiency you should
47
-        $replace = array_values(self::$unicodeCharacterMap); // pre-calculate these two arrays
48
-        return str_replace($character, $replace, html_entity_decode($string, ENT_QUOTES, "UTF-8"));
49
-    }
50
-
51
-    /**
52
-     * Multibyte.php safe version of standard trim() function.
53
-     *
54
-     * @param string $string
55
-     * @return string
56
-     */
57
-    public static function trim($string)
58
-    {
59
-        return mb_ereg_replace('^\s*([\s\S]*?)\s*$', '\1', $string);
60
-    }
61
-
62
-    /**
63
-     * A cross between mb_split and preg_split, adding the preg_split flags
64
-     * to mb_split.
65
-     *
66
-     * @param string $pattern
67
-     * @param string $string
68
-     * @param int $limit
69
-     * @param int $flags
70
-     * @return array
71
-     */
72
-    public static function split($pattern, $string, $limit = -1, $flags = 0)
73
-    {
74
-        $offset_capture = (bool)($flags & PREG_SPLIT_OFFSET_CAPTURE);
75
-
76
-        $lengths = self::getSplitLengths($pattern, $string);
77
-
78
-        // Substrings
79
-        $parts = [];
80
-        $position = 0;
81
-        $count = 1;
82
-        foreach ($lengths as $length) {
83
-            if (self::isLastPart($length, $flags, $limit, $count)) {
84
-                $parts[] = self::makePart($string, $position, null, $offset_capture);
85
-                return $parts;
86
-            }
87
-
88
-            if (self::isPart($length, $flags)) {
89
-                $parts[] = self::makePart($string, $position, $length[0], $offset_capture);
90
-            }
91
-
92
-            $position += $length[0];
93
-        }
94
-
95
-        return $parts;
96
-    }
97
-
98
-    /**
99
-     * @param $length
100
-     * @param $flags
101
-     * @param $limit
102
-     * @param $count
103
-     * @return bool
104
-     */
105
-    private static function isLastPart($length, $flags, $limit, &$count)
106
-    {
107
-        $split_empty = !($flags & PREG_SPLIT_NO_EMPTY) || $length[0];
108
-        $is_delimiter = $length[1];
109
-
110
-        return $limit > 0
111
-            && !$is_delimiter
112
-            && $split_empty
113
-            && ++$count > $limit;
114
-    }
115
-
116
-    /**
117
-     * @param $length
118
-     * @param $flags
119
-     * @return bool
120
-     */
121
-    private static function isPart($length, $flags)
122
-    {
123
-        $split_empty = !($flags & PREG_SPLIT_NO_EMPTY) || $length[0];
124
-        $is_delimiter = $length[1];
125
-        $is_captured = ($flags & PREG_SPLIT_DELIM_CAPTURE) && $length[2];
126
-
127
-        return (!$is_delimiter
128
-                || $is_captured)
129
-            && $split_empty;
130
-    }
131
-
132
-    /**
133
-     * Make part
134
-     * @param string $string
135
-     * @param integer $position
136
-     * @param integer|null $length
137
-     * @param bool $offset_capture
138
-     * @return array|string
139
-     */
140
-    private static function makePart($string, $position, $length = null, $offset_capture = false)
141
-    {
142
-        $cut = mb_strcut($string, $position, $length);
143
-
144
-        return $offset_capture
145
-            ? [$cut, $position]
146
-            : $cut;
147
-    }
148
-
149
-    /**
150
-     * Splits the string by pattern and for each element (part or split) returns:
151
-     *  [ 0 => length, 1 => is_delimiter?, 2 =>
152
-     *
153
-     * @param $pattern
154
-     * @param $string
155
-     * @return array
156
-     */
157
-    private static function getSplitLengths($pattern, $string)
158
-    {
159
-        $strlen = strlen($string); // bytes!
160
-        $lengths = [];
161
-
162
-        mb_ereg_search_init($string);
163
-
164
-        $position = 0;
165
-        while ($position < $strlen
166
-            && ($array = mb_ereg_search_pos($pattern, '')) !== false) {
167
-            // capture split
168
-            $lengths[] = [$array[0] - $position, false, null];
169
-
170
-            // move position
171
-            $position = $array[0] + $array[1];
172
-
173
-            // capture delimiter
174
-            $regs = mb_ereg_search_getregs();
175
-            $lengths[] = [$array[1], true, isset($regs[1]) && $regs[1]];
176
-        }
177
-
178
-        // Add last bit, if not ending with split
179
-        $lengths[] = [$strlen - $position, false, null];
180
-
181
-        return $lengths;
182
-    }
10
+	//https://stackoverflow.com/questions/20025030/convert-all-types-of-smart-quotes-with-php
11
+	private static $unicodeCharacterMap = [
12
+		// Windows codepage 1252
13
+		"\xC2\x82" => "'", // U+0082⇒U+201A single low-9 quotation mark
14
+		"\xC2\x84" => '"', // U+0084⇒U+201E double low-9 quotation mark
15
+		"\xC2\x8B" => "'", // U+008B⇒U+2039 single left-pointing angle quotation mark
16
+		"\xC2\x91" => "'", // U+0091⇒U+2018 left single quotation mark
17
+		"\xC2\x92" => "'", // U+0092⇒U+2019 right single quotation mark
18
+		"\xC2\x93" => '"', // U+0093⇒U+201C left double quotation mark
19
+		"\xC2\x94" => '"', // U+0094⇒U+201D right double quotation mark
20
+		"\xC2\x9B" => "'", // U+009B⇒U+203A single right-pointing angle quotation mark
21
+		// Regular Unicode     // U+0022 quotation mark (")
22
+		// U+0027 apostrophe     (')
23
+		"\xC2\xAB" => '"', // U+00AB left-pointing double angle quotation mark
24
+		"\xC2\xBB" => '"', // U+00BB right-pointing double angle quotation mark
25
+		"\xE2\x80\x98" => "'", // U+2018 left single quotation mark
26
+		"\xE2\x80\x99" => "'", // U+2019 right single quotation mark
27
+		"\xE2\x80\x9A" => "'", // U+201A single low-9 quotation mark
28
+		"\xE2\x80\x9B" => "'", // U+201B single high-reversed-9 quotation mark
29
+		"\xE2\x80\x9C" => '"', // U+201C left double quotation mark
30
+		"\xE2\x80\x9D" => '"', // U+201D right double quotation mark
31
+		"\xE2\x80\x9E" => '"', // U+201E double low-9 quotation mark
32
+		"\xE2\x80\x9F" => '"', // U+201F double high-reversed-9 quotation mark
33
+		"\xE2\x80\xB9" => "'", // U+2039 single left-pointing angle quotation mark
34
+		"\xE2\x80\xBA" => "'", // U+203A single right-pointing angle quotation mark
35
+	];
36
+
37
+	/**
38
+	 * Replace
39
+	 *
40
+	 * @staticvar array $chr_map
41
+	 * @param string $string
42
+	 * @return string
43
+	 */
44
+	public static function cleanUnicode($string)
45
+	{
46
+		$character = array_keys(self::$unicodeCharacterMap); // but: for efficiency you should
47
+		$replace = array_values(self::$unicodeCharacterMap); // pre-calculate these two arrays
48
+		return str_replace($character, $replace, html_entity_decode($string, ENT_QUOTES, "UTF-8"));
49
+	}
50
+
51
+	/**
52
+	 * Multibyte.php safe version of standard trim() function.
53
+	 *
54
+	 * @param string $string
55
+	 * @return string
56
+	 */
57
+	public static function trim($string)
58
+	{
59
+		return mb_ereg_replace('^\s*([\s\S]*?)\s*$', '\1', $string);
60
+	}
61
+
62
+	/**
63
+	 * A cross between mb_split and preg_split, adding the preg_split flags
64
+	 * to mb_split.
65
+	 *
66
+	 * @param string $pattern
67
+	 * @param string $string
68
+	 * @param int $limit
69
+	 * @param int $flags
70
+	 * @return array
71
+	 */
72
+	public static function split($pattern, $string, $limit = -1, $flags = 0)
73
+	{
74
+		$offset_capture = (bool)($flags & PREG_SPLIT_OFFSET_CAPTURE);
75
+
76
+		$lengths = self::getSplitLengths($pattern, $string);
77
+
78
+		// Substrings
79
+		$parts = [];
80
+		$position = 0;
81
+		$count = 1;
82
+		foreach ($lengths as $length) {
83
+			if (self::isLastPart($length, $flags, $limit, $count)) {
84
+				$parts[] = self::makePart($string, $position, null, $offset_capture);
85
+				return $parts;
86
+			}
87
+
88
+			if (self::isPart($length, $flags)) {
89
+				$parts[] = self::makePart($string, $position, $length[0], $offset_capture);
90
+			}
91
+
92
+			$position += $length[0];
93
+		}
94
+
95
+		return $parts;
96
+	}
97
+
98
+	/**
99
+	 * @param $length
100
+	 * @param $flags
101
+	 * @param $limit
102
+	 * @param $count
103
+	 * @return bool
104
+	 */
105
+	private static function isLastPart($length, $flags, $limit, &$count)
106
+	{
107
+		$split_empty = !($flags & PREG_SPLIT_NO_EMPTY) || $length[0];
108
+		$is_delimiter = $length[1];
109
+
110
+		return $limit > 0
111
+			&& !$is_delimiter
112
+			&& $split_empty
113
+			&& ++$count > $limit;
114
+	}
115
+
116
+	/**
117
+	 * @param $length
118
+	 * @param $flags
119
+	 * @return bool
120
+	 */
121
+	private static function isPart($length, $flags)
122
+	{
123
+		$split_empty = !($flags & PREG_SPLIT_NO_EMPTY) || $length[0];
124
+		$is_delimiter = $length[1];
125
+		$is_captured = ($flags & PREG_SPLIT_DELIM_CAPTURE) && $length[2];
126
+
127
+		return (!$is_delimiter
128
+				|| $is_captured)
129
+			&& $split_empty;
130
+	}
131
+
132
+	/**
133
+	 * Make part
134
+	 * @param string $string
135
+	 * @param integer $position
136
+	 * @param integer|null $length
137
+	 * @param bool $offset_capture
138
+	 * @return array|string
139
+	 */
140
+	private static function makePart($string, $position, $length = null, $offset_capture = false)
141
+	{
142
+		$cut = mb_strcut($string, $position, $length);
143
+
144
+		return $offset_capture
145
+			? [$cut, $position]
146
+			: $cut;
147
+	}
148
+
149
+	/**
150
+	 * Splits the string by pattern and for each element (part or split) returns:
151
+	 *  [ 0 => length, 1 => is_delimiter?, 2 =>
152
+	 *
153
+	 * @param $pattern
154
+	 * @param $string
155
+	 * @return array
156
+	 */
157
+	private static function getSplitLengths($pattern, $string)
158
+	{
159
+		$strlen = strlen($string); // bytes!
160
+		$lengths = [];
161
+
162
+		mb_ereg_search_init($string);
163
+
164
+		$position = 0;
165
+		while ($position < $strlen
166
+			&& ($array = mb_ereg_search_pos($pattern, '')) !== false) {
167
+			// capture split
168
+			$lengths[] = [$array[0] - $position, false, null];
169
+
170
+			// move position
171
+			$position = $array[0] + $array[1];
172
+
173
+			// capture delimiter
174
+			$regs = mb_ereg_search_getregs();
175
+			$lengths[] = [$array[1], true, isset($regs[1]) && $regs[1]];
176
+		}
177
+
178
+		// Add last bit, if not ending with split
179
+		$lengths[] = [$strlen - $position, false, null];
180
+
181
+		return $lengths;
182
+	}
183 183
 }
184 184
\ No newline at end of file
Please login to merge, or discard this patch.
Spacing   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -71,7 +71,7 @@
 block discarded – undo
71 71
      */
72 72
     public static function split($pattern, $string, $limit = -1, $flags = 0)
73 73
     {
74
-        $offset_capture = (bool)($flags & PREG_SPLIT_OFFSET_CAPTURE);
74
+        $offset_capture = (bool) ($flags & PREG_SPLIT_OFFSET_CAPTURE);
75 75
 
76 76
         $lengths = self::getSplitLengths($pattern, $string);
77 77
 
Please login to merge, or discard this patch.