enumcharnames.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlchar.enumcharnames" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>IntlChar::enumCharNames</refname>
  <refpurpose>Enumerate all assigned Unicode characters within a range</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="IntlChar">
   <modifier>public</modifier> <modifier>static</modifier> <type>bool</type><methodname>IntlChar::enumCharNames</methodname>
   <methodparam><type class="union"><type>int</type><type>string</type></type><parameter>start</parameter></methodparam>
   <methodparam><type class="union"><type>int</type><type>string</type></type><parameter>end</parameter></methodparam>
   <methodparam><type>callable</type><parameter>callback</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer>IntlChar::UNICODE_CHAR_NAME</initializer></methodparam>
  </methodsynopsis>
  <para>
   Enumerate all assigned Unicode characters between the start and limit code points (start inclusive, limit exclusive)
   and call a function for each, passing the code point value and the character name.
  </para>
  <para>
   For Unicode 1.0 names, only those are enumerated that differ from the modern names.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>start</parameter></term>
    <listitem>
     <para>
      The first code point in the enumeration range.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>end</parameter></term>
    <listitem>
     <para>
      One more than the last code point in the enumeration range (the first one after the range).
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>callback</parameter></term>
    <listitem>
     <para>
      The function that is to be called for each character name.  The following three arguments will be passed into it:
      <simplelist>
       <member><type>int</type> <literal>$codepoint</literal> - The numeric code point value</member>
       <member><type>int</type> <literal>$nameChoice</literal> - The same value as the <parameter>type</parameter> parameter below</member>
       <member><type>string</type> <literal>$name</literal> - The name of the character</member>
      </simplelist>
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>type</parameter></term>
    <listitem>
     <para>
      Selector for which kind of names to enumerate.  Can be any of these constants:
      <simplelist>
       <member><constant>IntlChar::UNICODE_CHAR_NAME</constant> (default)</member>
       <member><constant>IntlChar::UNICODE_10_CHAR_NAME</constant></member>
       <member><constant>IntlChar::EXTENDED_CHAR_NAME</constant></member>
       <member><constant>IntlChar::CHAR_NAME_ALIAS</constant></member>
       <member><constant>IntlChar::CHAR_NAME_CHOICE_COUNT</constant></member>
      </simplelist>
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <para>
   <informaltable>
    <tgroup cols="2">
     <thead>
      <row>
       <entry>&Version;</entry>
       <entry>&Description;</entry>
      </row>
     </thead>
     <tbody>
      <row>
       <entry>8.3.0</entry>
       <entry>
        This method now returns &false; on failure; previously it returns &null;.
       </entry>
      </row>
     </tbody>
    </tgroup>
   </informaltable>
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>Enumerating over a sample range of code points</title>
   <programlisting role="php">
    <![CDATA[
<?php
IntlChar::enumCharNames(0x2600, 0x2610, function($codepoint, $nameChoice, $name) {
    printf("U+%04x %s\n", $codepoint, $name);
});
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
    <![CDATA[
U+2600 BLACK SUN WITH RAYS
U+2601 CLOUD
U+2602 UMBRELLA
U+2603 SNOWMAN
U+2604 COMET
U+2605 BLACK STAR
U+2606 WHITE STAR
U+2607 LIGHTNING
U+2608 THUNDERSTORM
U+2609 SUN
U+260a ASCENDING NODE
U+260b DESCENDING NODE
U+260c CONJUNCTION
U+260d OPPOSITION
U+260e BLACK TELEPHONE
U+260f WHITE TELEPHONE
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>IntlChar::charName</function></member>
    <member><function>IntlChar::charFromName</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
-->