<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Get the type of the byte in the text</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.haruencoder.html">HaruEncoder</a></div>
<div class="next" style="text-align: right; float: right;"><a href="haruencoder.gettype.html">HaruEncoder::getType</a></div>
<div class="up"><a href="class.haruencoder.html">HaruEncoder</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="haruencoder.getbytetype" class="refentry">
<div class="refnamediv">
<h1 class="refname">HaruEncoder::getByteType</h1>
<p class="verinfo">(PECL haru >= 0.0.1)</p><p class="refpurpose"><span class="refname">HaruEncoder::getByteType</span> — <span class="dc-title">Get the type of the byte in the text</span></p>
</div>
<div class="refsect1 description" id="refsect1-haruencoder.getbytetype-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">int</span> <span class="methodname"><strong>HaruEncoder::getByteType</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$text</code></span>
, <span class="methodparam"><span class="type">int</span> <code class="parameter">$index</code></span>
)</div>
<p class="para rdfs-comment">
Get the type of the byte in the text.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-haruencoder.getbytetype-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">text</code></em></span>
<dd>
<p class="para">
The text.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">index</code></em></span>
<dd>
<p class="para">
The position in the text.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-haruencoder.getbytetype-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the type of the byte in the text on the specified position.
The result is one of the following values:
<ul class="simplelist">
<li class="member">
<strong><code>HaruEncoder::BYTE_TYPE_SINGLE</code></strong> - single byte
character.
</li>
<li class="member">
<strong><code>HaruEncoder::BYTE_TYPE_LEAD</code></strong> - lead byte of a
double-byte character.
</li>
<li class="member">
<strong><code>HaruEncoder::BYTE_TYPE_TRAIL</code></strong> - trailing byte of a
double-byte character.
</li>
<li class="member">
<strong><code>HaruEncoder::BYTE_TYPE_UNKNOWN</code></strong> - invalid encoder or
cannot detect the byte type.
</li>
</ul>
</p>
</div>
<div class="refsect1 errors" id="refsect1-haruencoder.getbytetype-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">Throws a <a href="class.haruexception.html" class="classname">HaruException</a> on error.</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.haruencoder.html">HaruEncoder</a></div>
<div class="next" style="text-align: right; float: right;"><a href="haruencoder.gettype.html">HaruEncoder::getType</a></div>
<div class="up"><a href="class.haruencoder.html">HaruEncoder</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
