<!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 Unicode name for a property value</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="intlchar.getpropertyvalueenum.html">IntlChar::getPropertyValueEnum</a></div> <div class="next" style="text-align: right; float: right;"><a href="intlchar.getunicodeversion.html">IntlChar::getUnicodeVersion</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.getpropertyvaluename" class="refentry"> <div class="refnamediv"> <h1 class="refname">IntlChar::getPropertyValueName</h1> <p class="verinfo">(PHP 7)</p><p class="refpurpose"><span class="refname">IntlChar::getPropertyValueName</span> — <span class="dc-title">Get the Unicode name for a property value</span></p> </div> <div class="refsect1 description" id="refsect1-intlchar.getpropertyvaluename-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="modifier">static</span> <span class="type">string</span> <span class="methodname"><strong>IntlChar::getPropertyValueName</strong></span> ( <span class="methodparam"><span class="type">int</span> <code class="parameter">$property</code></span> , <span class="methodparam"><span class="type">int</span> <code class="parameter">$value</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$nameChoice</code><span class="initializer"> = <strong><code>IntlChar::LONG_PROPERTY_NAME</code></strong></span></span> ] )</div> <p class="para rdfs-comment"> Returns the Unicode name for a given property value, as given in the Unicode database file PropertyValueAliases.txt. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> Some of the names in PropertyValueAliases.txt can only be retrieved using <strong><code>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</code></strong>, not <strong><code>IntlChar::PROPERTY_GENERAL_CATEGORY</code></strong>. These include: <ul class="simplelist"> <li class="member">"C" / "Other"</li> <li class="member">"L" / "Letter"</li> <li class="member">"LC" / "Cased_Letter"</li> <li class="member">"M" / "Mark"</li> <li class="member">"N" / "Number"</li> <li class="member">"P" / "Punctuation"</li> <li class="member">"S" / "Symbol"</li> <li class="member"> "Z" / "Separator"</li> </ul> </p> </p></blockquote> </div> <div class="refsect1 parameters" id="refsect1-intlchar.getpropertyvaluename-parameters"> <h3 class="title">Parameters</h3> <dl> <dt> <code class="parameter">property</code></dt> <dd> <p class="para">The Unicode property to lookup (see the <em>IntlChar::PROPERTY_*</em> constants).</p> <p class="para"> If out of range, or this method doesn't work with the given value, <strong><code>FALSE</code></strong> is returned. </p> </dd> <dt> <code class="parameter">value</code></dt> <dd> <p class="para"> Selector for a value for the given property. If out of range, <strong><code>FALSE</code></strong> is returned. </p> <p class="para"> In general, valid values range from <em>0</em> up to some maximum. There are a couple exceptions: <ul class="simplelist"> <li class="member"> <strong><code>IntlChar::PROPERTY_BLOCK</code></strong> values begin at the non-zero value <strong><code>IntlChar::BLOCK_CODE_BASIC_LATIN</code></strong> </li> <li class="member"> <strong><code>IntlChar::PROPERTY_CANONICAL_COMBINING_CLASS</code></strong> values are not contiguous and range from 0..240. </li> </ul> </p> </dd> <dt> <code class="parameter">nameChoice</code></dt> <dd> <p class="para"> Selector for which name to get. If out of range, <strong><code>FALSE</code></strong> is returned. </p> <p class="para"> All values have a long name. Most have a short name, but some do not. Unicode allows for additional names; if present these will be returned by adding 1, 2, etc. to <strong><code>IntlChar::LONG_PROPERTY_NAME</code></strong>. </p> </dd> </dl> </div> <div class="refsect1 returnvalues" id="refsect1-intlchar.getpropertyvaluename-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the name, or <strong><code>FALSE</code></strong> if either the <code class="parameter">property</code> or the <code class="parameter">nameChoice</code> is out of range. </p> <p class="para"> If a given <code class="parameter">nameChoice</code> returns <strong><code>FALSE</code></strong>, then all larger values of <code class="parameter">nameChoice</code> will return <strong><code>FALSE</code></strong>, with one exception: if <strong><code>FALSE</code></strong> is returned for <strong><code>IntlChar::SHORT_PROPERTY_NAME</code></strong>, then <strong><code>IntlChar::LONG_PROPERTY_NAME</code></strong> (and higher) may still return a non-<strong><code>FALSE</code></strong> value. </p> </div> <div class="refsect1 examples" id="refsect1-intlchar.getpropertyvaluename-examples"> <h3 class="title">Examples</h3> <div class="example" id="example-3215"> <p><strong>Example #1 Testing different properties</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">getPropertyValueName</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">PROPERTY_BLOCK</span><span style="color: #007700">, </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">BLOCK_CODE_GREEK</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">getPropertyValueName</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">PROPERTY_BLOCK</span><span style="color: #007700">, </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">BLOCK_CODE_GREEK</span><span style="color: #007700">, </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">SHORT_PROPERTY_NAME</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">getPropertyValueName</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">PROPERTY_BLOCK</span><span style="color: #007700">, </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">BLOCK_CODE_GREEK</span><span style="color: #007700">, </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">LONG_PROPERTY_NAME</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">getPropertyValueName</span><span style="color: #007700">(</span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">PROPERTY_BLOCK</span><span style="color: #007700">, </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">BLOCK_CODE_GREEK</span><span style="color: #007700">, </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">LONG_PROPERTY_NAME </span><span style="color: #007700">+ </span><span style="color: #0000BB">1</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> string(16) "Greek_And_Coptic" string(5) "Greek" string(16) "Greek_And_Coptic" bool(false) </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.getpropertyvalueenum.html">IntlChar::getPropertyValueEnum</a></div> <div class="next" style="text-align: right; float: right;"><a href="intlchar.getunicodeversion.html">IntlChar::getUnicodeVersion</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>