[prev in list] [next in list] [prev in thread] [next in thread] 

List:       pear-doc
Subject:    [PEAR-DOC] cvs: peardoc /en/package numbers.xml  /en/package/numbers numbers-roman.xml
From:       "Christian Weiske" <cweiske () php ! net>
Date:       2007-06-28 6:33:30
Message-ID: cvscweiske1183012410 () cvsserver
[Download RAW message or body]

cweiske		Thu Jun 28 06:33:30 2007 UTC

  Added files:                 
    /peardoc/en/package/numbers	numbers-roman.xml 

  Modified files:              
    /peardoc/en/package	numbers.xml 
  Log:
  Add documentation for Numbers_Roman
  
  
http://cvs.php.net/viewvc.cgi/peardoc/en/package/numbers.xml?r1=1.5&r2=1.6&diff_format=u
Index: peardoc/en/package/numbers.xml
diff -u peardoc/en/package/numbers.xml:1.5 peardoc/en/package/numbers.xml:1.6
--- peardoc/en/package/numbers.xml:1.5	Fri Feb 17 16:04:31 2006
+++ peardoc/en/package/numbers.xml	Thu Jun 28 06:33:30 2007
@@ -1,4 +1,4 @@
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
 <chapter id="package.numbers">
 
  <title>Numbers</title>
@@ -9,6 +9,8 @@
 
  &blankpagehack;
 
+ &package.numbers.numbers-roman;
+
 </chapter>
 <!-- Keep this comment at the end of the file
 Local variables:

http://cvs.php.net/viewvc.cgi/peardoc/en/package/numbers/numbers-roman.xml?view=markup&rev=1.1
Index: peardoc/en/package/numbers/numbers-roman.xml
+++ peardoc/en/package/numbers/numbers-roman.xml
<?xml version="1.0" encoding="utf-8" ?>
<!-- $Revision: 1.1 $ -->
<sect1 id="package.numbers.numbers-roman">
 <title>Numbers_Roman</title>

 <para>
  <classname>Numbers_Roman</classname> provides methods
  to convert Arabic numbers like <literal>23</literal> into Roman numerals
  like <literal>XXIII</literal> and back.
 </para>

 <note>
  <para>
   Both class methods are static; you do not need to instantiate an object.
  </para>
 </note>

 <sect2>
  <title>Converting Arabic to Roman Numerals</title>

  <para>
   The static method <methodname>toNumeral</methodname> does exactly this.
   It can be used for numbers from <literal>1</literal> to
   <literal>5 999 999</literal>.
   Using it to convert higher numbers works, but does not produce historically
    correct results.
  </para>

  <para>
   The second parameter <literal>$uppercase</literal> determines if the letters
    should be UPPERCASE (default) or not.
   Parameter number 3 sets if HTML code for overscores shall be generated;
    this is necessary for numbers greater than 3999. If the parameter is set to
    false, letters will be prefixed with an underscore <literal>_</literal>.
  </para>

  <example>
   <title>Converting Arabic numbers to Roman numerals</title>
   <programlisting role="php"><![CDATA[
<?php
require_once 'Numbers/Roman.php';

echo Numbers_Roman::toNumeral(23);
//returns: XXIII

echo Numbers_Roman::toNumeral(23, false);
//returns: xxiii
?>
]]></programlisting>
  </example>
 </sect2>


 <sect2>
  <title>Converting Roman Numerals to Arabic numbers</title>

  <para>
   Using the static method <methodname>toNumber</methodname> you can convert Roman
   numerals like <literal>XLII</literal> to Arabic numbers like
   <literal>42</literal>.
   Letters prefixed with an underscore represent numbers larger than 1000.
  </para>

  <table>
   <title>Conversion Table: Roman letter to Arabic number</title>
   <tgroup cols="2">
    <thead>
     <row><entry>Roman</entry> <entry>Arabic</entry></row>
    </thead>
    <tbody>
     <row><entry>I</entry> <entry>1</entry>   </row>
     <row><entry>V</entry> <entry>5</entry>   </row>
     <row><entry>X</entry> <entry>10</entry>  </row>
     <row><entry>L</entry> <entry>50</entry>  </row>
     <row><entry>C</entry> <entry>100</entry> </row>
     <row><entry>D</entry> <entry>500</entry> </row>
     <row><entry>M</entry> <entry>1000</entry> </row>
     <row><entry>S, _V</entry> <entry>5000</entry></row>
     <row><entry>R, _X</entry> <entry>10 000</entry></row>
     <row><entry>P, _L</entry> <entry>50 000</entry></row>
     <row><entry>Q, _C</entry> <entry>100 000</entry></row>
     <row><entry>O, _D</entry> <entry>500 000</entry></row>
     <row><entry>N, _M</entry> <entry>1 000 000</entry></row>
    </tbody>
   </tgroup>
  </table>

  <example>
   <title>Converting Roman numerals to Arabic numbers</title>
   <programlisting role="php"><![CDATA[
<?php
require_once 'Numbers/Roman.php';

echo Numbers_Roman::toNumber('XLII');
//returns: 42
?>
]]></programlisting>
  </example>
 </sect2>

</sect1>

<!-- 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
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../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
-->

-- 
PEAR Documentation List Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php

[prev in list] [next in list] [prev in thread] [next in thread]