<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlchar.getintpropertyvalue" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>IntlChar::getIntPropertyValue</refname>
  <refpurpose>Get the value for a Unicode property for a code point</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="IntlChar">
   <modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>int</type><type>null</type></type><methodname>IntlChar::getIntPropertyValue</methodname>
   <methodparam><type class="union"><type>int</type><type>string</type></type><parameter>codepoint</parameter></methodparam>
   <methodparam><type>int</type><parameter>property</parameter></methodparam>
  </methodsynopsis>
  <para>
   Gets the property value for an enumerated or integer Unicode property for a code point.
   Also returns binary and mask property values.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>codepoint</parameter></term>
    <listitem>
     &intl.codepoint.parameter;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>property</parameter></term>
    <listitem>
     &intl.property.parameter;
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the numeric value that is directly the property value or, for enumerated properties, corresponds to the
   numeric value of the enumerated constant of the respective property value enumeration type. Returns &null; on failure.
  </para>
  <para>
   Returns <literal>0</literal> or <literal>1</literal> (for &false;/&true;) for binary Unicode properties.
  </para>
  <para>
   Returns a bit-mask for mask properties.
  </para>
  <para>
   Returns <literal>0</literal> if <parameter>property</parameter> is out of bounds or if the Unicode version does not
   have data for the property at all, or not for this code point.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>&intl.property.example;</title>
   <programlisting role="php">
    <![CDATA[
<?php
var_dump(IntlChar::getIntPropertyValue("A", IntlChar::PROPERTY_ALPHABETIC) === 1);
var_dump(IntlChar::getIntPropertyValue("[", IntlChar::PROPERTY_BIDI_MIRRORED) === 1);
var_dump(IntlChar::getIntPropertyValue("Φ", IntlChar::PROPERTY_BLOCK) === IntlChar::BLOCK_CODE_GREEK);
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
    <![CDATA[
bool(true)
bool(true)
bool(true)
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>IntlChar::hasBinaryProperty</function></member>
    <member><function>IntlChar::getIntPropertyMinValue</function></member>
    <member><function>IntlChar::getIntPropertyMaxValue</function></member>
    <member><function>IntlChar::getUnicodeVersion</function></member>
   </simplelist>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
