1<!DOCTYPE html>
2<html>
3<head>
4	<meta charset="utf-8">
5
6	<title>Class Sentence | phpSentence</title>
7
8	<link rel="stylesheet" href="resources/style.css?e99947befd7bf673c6b43ff75e9e0f170c88a60e">
9
10</head>
11
12<body>
13<div id="left">
14	<div id="menu">
15		<a href="index.html" title="Overview"><span>Overview</span></a>
16
17
18		<div id="groups">
19		</div>
20
21
22
23		<div id="elements">
24			<h3>Classes</h3>
25			<ul>
26				<li class="active"><a href="class-Sentence.html">Sentence</a></li>
27				<li><a href="class-SentenceTest.html">SentenceTest</a></li>
28			</ul>
29
30
31
32
33
34			<h3>Functions</h3>
35			<ul>
36				<li><a href="function-Sentence_autoloader.html">Sentence_autoloader</a></li>
37			</ul>
38		</div>
39	</div>
40</div>
41
42<div id="splitter"></div>
43
44<div id="right">
45<div id="rightInner">
46	<form id="search">
47		<input type="hidden" name="cx" value="">
48		<input type="hidden" name="ie" value="UTF-8">
49		<input type="text" name="q" class="text" placeholder="Search">
50	</form>
51
52	<div id="navigation">
53		<ul>
54			<li>
55				<a href="index.html" title="Overview"><span>Overview</span></a>
56			</li>
57			<li class="active">
58<span>Class</span>			</li>
59		</ul>
60		<ul>
61		</ul>
62		<ul>
63		</ul>
64	</div>
65
66<div id="content" class="class">
67	<h1>Class Sentence</h1>
68
69
70	<div class="description">
71	<p>Segments sentences.
72Clipping may not be perfect.
73Sentence count should be VERY close to the truth.</p>
74
75<p>Multibyte safe (atleast for UTF-8), but rules based on germanic
76language stucture (English, Dutch, German). Should work for most
77latin-alphabet languages.</p>
78	</div>
79
80
81
82
83
84
85
86
87
88	<div class="info">
89
90
91
92
93
94			<b>Located at</b> <a href="source-class-Sentence.html#3-328" title="Go to source code">classes/Sentence.php</a>
95		<br>
96	</div>
97
98
99
100	<table class="summary methods" id="methods">
101	<caption>Methods summary</caption>
102	<tr data-order="split" id="_split">
103
104		<td class="attributes"><code>
105			 public
106
107			array
108
109			</code>
110		</td>
111
112		<td class="name"><div>
113		<a class="anchor" href="#_split">#</a>
114		<code><a href="source-class-Sentence.html#289-318" title="Go to source code">split</a>( <span>string <var>$text</var></span>, <span>integer <var>$flags</var> = <span class="php-num">0</span></span> )</code>
115
116		<div class="description short">
117			<p>Return the sentences sentences detected in the provided text.
118Set the Sentence::SPLIT_TRIM flag to trim whitespace.</p>
119		</div>
120
121		<div class="description detailed hidden">
122			<p>Return the sentences sentences detected in the provided text.
123Set the Sentence::SPLIT_TRIM flag to trim whitespace.</p>
124
125
126				<h4>Parameters</h4>
127				<div class="list"><dl>
128					<dt><var>$text</var></dt>
129					<dd></dd>
130					<dt><var>$flags</var></dt>
131					<dd></dd>
132				</dl></div>
133
134				<h4>Returns</h4>
135				<div class="list">
136					array
137				</div>
138
139
140
141
142		</div>
143		</div></td>
144	</tr>
145	<tr data-order="count" id="_count">
146
147		<td class="attributes"><code>
148			 public
149
150			integer
151
152			</code>
153		</td>
154
155		<td class="name"><div>
156		<a class="anchor" href="#_count">#</a>
157		<code><a href="source-class-Sentence.html#320-327" title="Go to source code">count</a>( <span>string <var>$text</var></span> )</code>
158
159		<div class="description short">
160			<p>Return the number of sentences detected in the provided text.</p>
161		</div>
162
163		<div class="description detailed hidden">
164			<p>Return the number of sentences detected in the provided text.</p>
165
166
167				<h4>Parameters</h4>
168				<div class="list"><dl>
169					<dt><var>$text</var></dt>
170					<dd></dd>
171				</dl></div>
172
173				<h4>Returns</h4>
174				<div class="list">
175					integer
176				</div>
177
178
179
180
181		</div>
182		</div></td>
183	</tr>
184	</table>
185
186
187
188
189
190
191
192
193	<table class="summary constants" id="constants">
194	<caption>Constants summary</caption>
195	<tr data-order="SPLIT_TRIM" id="SPLIT_TRIM">
196
197		<td class="attributes"><code>integer</code></td>
198		<td class="name">
199			<code>
200				<a href="source-class-Sentence.html#13-16" title="Go to source code"><b>SPLIT_TRIM</b></a>
201			</code>
202
203			<div class="description short">
204				<p>Specify this flag with the split method to trim whitespace.</p>
205			</div>
206
207			<div class="description detailed hidden">
208				<p>Specify this flag with the split method to trim whitespace.</p>
209
210			</div>
211		</td>
212		<td class="value">
213			<div>
214				<a href="#SPLIT_TRIM" class="anchor">#</a>
215				<code><span class="php-num">0x1</span></code>
216			</div>
217		</td>
218	</tr>
219	</table>
220
221
222
223
224
225
226
227
228
229
230</div>
231
232	<div id="footer">
233		phpSentence API documentation generated by <a href="http://apigen.org">ApiGen</a>
234	</div>
235</div>
236</div>
237<script src="resources/combined.js"></script>
238<script src="elementlist.js"></script>
239</body>
240</html>
241