ext/bcmath: BcMath\Number class

language-snippets.ent

@@ -2155,6 +2155,11 @@ of digits after the decimal place in the result. If omitted, it will default to
 globally with the <function>bcscale</function> function, or fallback to <literal>0</literal> if
 this has not been set.</para></listitem></varlistentry>'>
 
+<!ENTITY bc.number.scale.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term>
+<parameter>scale</parameter></term><listitem><simpara><parameter>scale</parameter> explicitly
+specified for calculation results. If &null;, the <parameter>scale</parameter> of the calculation
+result will be set automatically.</simpara></listitem></varlistentry>'>
+
 <!-- CTYPE Notes -->
 <!ENTITY note.ctype.parameter.integer '<note xmlns="http://docbook.org/ns/docbook"><para>
 If an <type>int</type> between -128 and 255 inclusive is provided, it is interpreted as

reference/bc/bcmath.number.xml

@@ -0,0 +1,112 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<reference xml:id="class.bcmath-number" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+
+ <title>The BcMath\Number class</title>
+ <titleabbrev>BcMath\Number</titleabbrev>
+
+ <partintro>
+  <section xml:id="bcmath-number.intro">
+   &reftitle.intro;
+   <para>
+    A class for an arbitrary precision number. These objects support overloaded
+    <link linkend="language.operators.arithmetic">arithmetic</link> and
+    <link linkend="language.operators.comparison">comparison</link> operators.
+   </para>
+
+   <note>
+    <simpara>This class is not affected by <parameter>bcmath.scale</parameter> in &php.ini;.</simpara>
+   </note>
+
+   <note>
+    <simpara>
+     For more information about calculations with operators, see the documentation
+     for the methods that correspond to the operators.
+    </simpara>
+   </note>
+  </section>
+
+  <section xml:id="bcmath-number.synopsis">
+   &reftitle.classsynopsis;
+
+   <classsynopsis class="class">
+    <ooclass>
+     <modifier>final</modifier>
+     <modifier>readonly</modifier>
+     <classname>BcMath\Number</classname>
+    </ooclass>
+
+    <oointerface>
+     <modifier>implements</modifier>
+     <interfacename>Stringable</interfacename>
+    </oointerface>
+
+    <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <type>string</type>
+     <varname linkend="bcmath-number.props.value">value</varname>
+    </fieldsynopsis>
+    <fieldsynopsis>
+     <modifier>public</modifier>
+     <type>int</type>
+     <varname linkend="bcmath-number.props.scale">scale</varname>
+    </fieldsynopsis>
+
+    <classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.bcmath-number')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='BcMath\\Number'])">
+     <xi:fallback/>
+    </xi:include>
+    <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.bcmath-number')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='BcMath\\Number'])">
+     <xi:fallback/>
+    </xi:include>
+   </classsynopsis>
+  </section>
+
+  <section xml:id="bcmath-number.props">
+   &reftitle.properties;
+   <variablelist>
+    <varlistentry xml:id="bcmath-number.props.value">
+     <term><varname>value</varname></term>
+     <listitem>
+      <para>
+       A string representation of an arbitrary precision number.
+      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry xml:id="bcmath-number.props.scale">
+     <term><varname>scale</varname></term>
+     <listitem>
+      <para>
+       The scale value currently set on the object.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </section>
+
+ </partintro>
+
+ &reference.bc.bcmath.entities.number;
+
+</reference>
+<!-- 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
+-->