cii-text-analysis/vendor/vanderlee/php-sentence/doc/class-Sentence.html

<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">

	<title>Class Sentence | phpSentence</title>

	<link rel="stylesheet" href="resources/style.css?e99947befd7bf673c6b43ff75e9e0f170c88a60e">

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
		</div>



		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li class="active"><a href="class-Sentence.html">Sentence</a></li>
				<li><a href="class-SentenceTest.html">SentenceTest</a></li>
			</ul>





			<h3>Functions</h3>
			<ul>
				<li><a href="function-Sentence_autoloader.html">Sentence_autoloader</a></li>
			</ul>
		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="">
		<input type="hidden" name="ie" value="UTF-8">
		<input type="text" name="q" class="text" placeholder="Search">
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li class="active">
<span>Class</span>			</li>
		</ul>
		<ul>
		</ul>
		<ul>
		</ul>
	</div>

<div id="content" class="class">
	<h1>Class Sentence</h1>


	<div class="description">
	<p>Segments sentences.
Clipping may not be perfect.
Sentence count should be VERY close to the truth.</p>

<p>Multibyte safe (atleast for UTF-8), but rules based on germanic
language stucture (English, Dutch, German). Should work for most
latin-alphabet languages.</p>
	</div>









	<div class="info">
		
		
		
		

			<b>Located at</b> <a href="source-class-Sentence.html#3-328" title="Go to source code">classes/Sentence.php</a>
		<br>
	</div>



	<table class="summary methods" id="methods">
	<caption>Methods summary</caption>
	<tr data-order="split" id="_split">

		<td class="attributes"><code>
			 public 

			array
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_split">#</a>
		<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>

		<div class="description short">
			<p>Return the sentences sentences detected in the provided text.
Set the Sentence::SPLIT_TRIM flag to trim whitespace.</p>
		</div>

		<div class="description detailed hidden">
			<p>Return the sentences sentences detected in the provided text.
Set the Sentence::SPLIT_TRIM flag to trim whitespace.</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$text</var></dt>
					<dd></dd>
					<dt><var>$flags</var></dt>
					<dd></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					array
				</div>




		</div>
		</div></td>
	</tr>
	<tr data-order="count" id="_count">

		<td class="attributes"><code>
			 public 

			integer
			
			</code>
		</td>

		<td class="name"><div>
		<a class="anchor" href="#_count">#</a>
		<code><a href="source-class-Sentence.html#320-327" title="Go to source code">count</a>( <span>string <var>$text</var></span> )</code>

		<div class="description short">
			<p>Return the number of sentences detected in the provided text.</p>
		</div>

		<div class="description detailed hidden">
			<p>Return the number of sentences detected in the provided text.</p>


				<h4>Parameters</h4>
				<div class="list"><dl>
					<dt><var>$text</var></dt>
					<dd></dd>
				</dl></div>

				<h4>Returns</h4>
				<div class="list">
					integer
				</div>




		</div>
		</div></td>
	</tr>
	</table>








	<table class="summary constants" id="constants">
	<caption>Constants summary</caption>
	<tr data-order="SPLIT_TRIM" id="SPLIT_TRIM">

		<td class="attributes"><code>integer</code></td>
		<td class="name">
			<code>
				<a href="source-class-Sentence.html#13-16" title="Go to source code"><b>SPLIT_TRIM</b></a>
			</code>

			<div class="description short">
				<p>Specify this flag with the split method to trim whitespace.</p>
			</div>

			<div class="description detailed hidden">
				<p>Specify this flag with the split method to trim whitespace.</p>

			</div>
		</td>
		<td class="value">
			<div>
				<a href="#SPLIT_TRIM" class="anchor">#</a>
				<code><span class="php-num">0x1</span></code>
			</div>
		</td>
	</tr>
	</table>










</div>

	<div id="footer">
		phpSentence API documentation generated by <a href="http://apigen.org">ApiGen</a>
	</div>
</div>
</div>
<script src="resources/combined.js"></script>
<script src="elementlist.js"></script>
</body>
</html>