<!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 property constant value for a given property name</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlchar.getnumericvalue.html">IntlChar::getNumericValue</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlchar.getpropertyname.html">IntlChar::getPropertyName</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.getpropertyenum" class="refentry">
<div class="refnamediv">
<h1 class="refname">IntlChar::getPropertyEnum</h1>
<p class="verinfo">(PHP 7)</p><p class="refpurpose"><span class="refname">IntlChar::getPropertyEnum</span> — <span class="dc-title">Get the property constant value for a given property name</span></p>
</div>
<div class="refsect1 description" id="refsect1-intlchar.getpropertyenum-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::getPropertyEnum</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$alias</code></span>
)</div>
<p class="para rdfs-comment">
Returns the property constant value for a given property name, as specified in the Unicode database file PropertyAliases.txt.
Short, long, and any other variants are recognized.
</p>
<p class="para">
In addition, this function maps the synthetic names "gcm" / "General_Category_Mask" to the property
<strong><code>IntlChar::PROPERTY_GENERAL_CATEGORY_MASK</code></strong>. These names are not in PropertyAliases.txt.
</p>
<p class="para">
This function compliments <span class="function"><a href="intlchar.getpropertyname.html" class="function">IntlChar::getPropertyName()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-intlchar.getpropertyenum-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<code class="parameter">alias</code></dt>
<dd>
<p class="para">
The property name to be matched. The name is compared using "loose matching" as described in PropertyAliases.txt.
</p>
</dd>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-intlchar.getpropertyenum-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns an <em>IntlChar::PROPERTY_</em> constant value,
or <strong><code>IntlChar::PROPERTY_INVALID_CODE</code></strong> if the given name does not match any property.
</p>
</div>
<div class="refsect1 examples" id="refsect1-intlchar.getpropertyenum-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-3212">
<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">getPropertyEnum</span><span style="color: #007700">(</span><span style="color: #DD0000">'Bidi_Class'</span><span style="color: #007700">) === </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">PROPERTY_BIDI_CLASS</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">getPropertyEnum</span><span style="color: #007700">(</span><span style="color: #DD0000">'script'</span><span style="color: #007700">) === </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">PROPERTY_SCRIPT</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">getPropertyEnum</span><span style="color: #007700">(</span><span style="color: #DD0000">'IDEOGRAPHIC'</span><span style="color: #007700">) === </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">PROPERTY_IDEOGRAPHIC</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">getPropertyEnum</span><span style="color: #007700">(</span><span style="color: #DD0000">'Some made-up string'</span><span style="color: #007700">) === </span><span style="color: #0000BB">IntlChar</span><span style="color: #007700">::</span><span style="color: #0000BB">PROPERTY_INVALID_CODE</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 class="refsect1 seealso" id="refsect1-intlchar.getpropertyenum-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><span class="function"><a href="intlchar.getpropertyname.html" class="function" rel="rdfs-seeAlso">IntlChar::getPropertyName()</a> - Get the Unicode name for a property</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="intlchar.getnumericvalue.html">IntlChar::getNumericValue</a></div>
<div class="next" style="text-align: right; float: right;"><a href="intlchar.getpropertyname.html">IntlChar::getPropertyName</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>
