fordigit.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="intlchar.fordigit" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>IntlChar::forDigit</refname>
  <refpurpose>Get character representation for a given digit and radix</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis role="IntlChar">
   <modifier>public</modifier> <modifier>static</modifier> <type>int</type><methodname>IntlChar::forDigit</methodname>
   <methodparam><type>int</type><parameter>digit</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>base</parameter><initializer>10</initializer></methodparam>
  </methodsynopsis>
  <para>
   Determines the character representation for a specific digit in the specified radix.
  </para>
  <para>
   If the value of radix is not a valid radix, or the value of digit is not a valid digit in the specified radix,
   the null character (<literal>U+0000</literal>) is returned.
  </para>
  <para>
   The radix argument is valid if it is greater than or equal to <literal>2</literal> and less than or equal to <literal>36</literal>.
   The digit argument is valid if <literal>0 &lt;= digit &lt; radix</literal>.
  </para>
  <para>
   If the digit is less than <literal>10</literal>, then '0' + digit is returned. Otherwise, the value 'a' + digit - 10 is returned.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>digit</parameter></term>
    <listitem>
     <para>
      The number to convert to a character.
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>base</parameter></term>
    <listitem>
     <para>
      The radix (defaults to <literal>10</literal>).
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   The character representation (as a <type>int</type>) of the specified digit in the specified radix.
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <example>
   <title>&intl.codepoint.example;</title>
   <programlisting role="php">
    <![CDATA[
<?php
var_dump(IntlChar::forDigit(0));
var_dump(IntlChar::forDigit(3));
var_dump(IntlChar::forDigit(3, 10));
var_dump(IntlChar::forDigit(10));
var_dump(IntlChar::forDigit(10, 16));
?>
]]>
   </programlisting>
   &example.outputs;
   <screen>
    <![CDATA[
int(48)
int(51)
int(51)
int(0)
int(97)
]]>
   </screen>
  </example>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>IntlChar::digit</function></member>
    <member><function>IntlChar::charDigitValue</function></member>
    <member><function>IntlChar::isdigit</function></member>
    <member><constant>IntlChar::PROPERTY_NUMERIC_TYPE</constant></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
-->