<!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 bidirectional category value for a code point</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlchar.chardigitvalue.html">IntlChar::charDigitValue</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlchar.charfromname.html">IntlChar::charFromName</a></div>
<div class="up"><a href="class.intlchar.html">IntlChar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="intlchar.chardirection" class="refentry">
<div class="refnamediv">
<h1 class="refname">IntlChar::charDirection</h1>
<p class="verinfo">(PHP 7)</p><p class="refpurpose"><span class="refname">IntlChar::charDirection</span> — <span class="dc-title">Get bidirectional category value for a code point</span></p>
</div>
<div class="refsect1 description" id="refsect1-intlchar.chardirection-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">int</span> <span class="methodname"><strong>IntlChar::charDirection</strong></span>
( <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$codepoint</code></span>
)</div>
<p class="para rdfs-comment">
Returns the bidirectional category value for the code point, which is used in the <a href="http://www.unicode.org/reports/tr9/" class="link external">» Unicode bidirectional algorithm (UAX #9)</a>.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
Some unassigned code points have bidi values of R or AL because they are in blocks that are reserved for Right-To-Left scripts.
</p>
</p></blockquote>
</div>
<div class="refsect1 parameters" id="refsect1-intlchar.chardirection-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">codepoint</code></dt>
<dd>
<p class="para">The <span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span> codepoint value (e.g. <em>0x2603</em> for <em class="emphasis">U+2603 SNOWMAN</em>), or the character encoded as a UTF-8 <span class="type"><a href="language.types.string.html" class="type string">string</a></span> (e.g. <em>"\u{2603}"</em>)</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-intlchar.chardirection-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
The bidirectional category value; one of the following constants:
<ul class="simplelist">
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER_SEPARATOR</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_EUROPEAN_NUMBER_TERMINATOR</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_ARABIC_NUMBER</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_COMMON_NUMBER_SEPARATOR</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_BLOCK_SEPARATOR</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_SEGMENT_SEPARATOR</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_WHITE_SPACE_NEUTRAL</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_OTHER_NEUTRAL</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_EMBEDDING</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_OVERRIDE</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_ARABIC</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_EMBEDDING</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_OVERRIDE</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_POP_DIRECTIONAL_FORMAT</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_DIR_NON_SPACING_MARK</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_BOUNDARY_NEUTRAL</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_FIRST_STRONG_ISOLATE</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_LEFT_TO_RIGHT_ISOLATE</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_RIGHT_TO_LEFT_ISOLATE</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_POP_DIRECTIONAL_ISOLATE</code></strong></li>
<li class="member"><strong><code>IntlChar::CHAR_DIRECTION_CHAR_DIRECTION_COUNT</code></strong></li>
</ul>
</p>
</div>
<div class="refsect1 examples" id="refsect1-intlchar.chardirection-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-3194">
<p><strong>Example #1 Testing different code points</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">charDirection</span><span style="color: #007700">(</span><span style="color: #DD0000">"A"</span><span style="color: #007700">) === </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">CHAR_DIRECTION_LEFT_TO_RIGHT</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">charDirection</span><span style="color: #007700">(</span><span style="color: #DD0000">"\u{05E9}"</span><span style="color: #007700">) === </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">CHAR_DIRECTION_RIGHT_TO_LEFT</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">charDirection</span><span style="color: #007700">(</span><span style="color: #DD0000">"+"</span><span style="color: #007700">) === </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">CHAR_DIRECTION_EUROPEAN_NUMBER_SEPARATOR</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">charDirection</span><span style="color: #007700">(</span><span style="color: #DD0000">"."</span><span style="color: #007700">) === </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">CHAR_DIRECTION_COMMON_NUMBER_SEPARATOR</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
bool(true)
bool(true)
bool(true)
bool(true)
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlchar.chardigitvalue.html">IntlChar::charDigitValue</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlchar.charfromname.html">IntlChar::charFromName</a></div>
<div class="up"><a href="class.intlchar.html">IntlChar</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
