<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlchar.charfromname" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>IntlChar::charFromName</refname>
  <refpurpose>Find Unicode character by name and return its code point value</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::charFromName</methodname>
   <methodparam><type>string</type><parameter>name</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>type</parameter><initializer>IntlChar::UNICODE_CHAR_NAME</initializer></methodparam>
  </methodsynopsis>
  <para>
   Finds a Unicode character by its name and returns its code point value.
  </para>
  <para>
   The name is matched exactly and completely. If the name does not correspond to a code point, &null; is returned.
  </para>
  <para>
   A Unicode 1.0 name is matched only if it differs from the modern name. Unicode names are all uppercase.
   Extended names are lowercase followed by an uppercase hexadecimal number, and within angle brackets.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>name</parameter></term>
    <listitem>
     <para>
      Full name of the Unicode character.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>type</parameter></term>
    <listitem>
     <para>
      Which set of names to use for the lookup. 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>
   The Unicode value of the code point with the given name (as an <type>int</type>), or &null; if there is no such code point.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>&intl.codepoint.example;</title>
   <programlisting role="php">
    <![CDATA[
<?php
var_dump(IntlChar::charFromName("LATIN CAPITAL LETTER A"));
var_dump(IntlChar::charFromName("SNOWMAN"));
var_dump(IntlChar::charFromName("RECYCLING SYMBOL FOR TYPE-1 PLASTICS"));
var_dump(IntlChar::charFromName("A RANDOM STRING WHICH DOESN'T CORRESPOND TO ANY UNICODE CHARACTER"));
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
    <![CDATA[
int(65)
int(9731)
int(9843)
NULL
]]>
   </screen>
  </example>
 </refsect1>

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