Fixed and added exception behavior. Also added a literal tag

php · Nov 27, 2024 · d0aea10 · d0aea10
1 parent 0e48683
commit d0aea10
Show file tree

Hide file tree

Showing 12 changed files with 125 additions and 12 deletions.
diff --git a/reference/bc/functions/bcadd.xml b/reference/bc/functions/bcadd.xml
@@ -51,7 +51,18 @@
    The sum of the two operands, as a string.
   </para>
  </refsect1>
-
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   This function throws a <exceptionname>ValueError</exceptionname> in the following cases:
+   <simplelist>
+    <member><parameter>num1</parameter> or <parameter>num2</parameter> is not a well-formed BCMath numeric string</member>
+    <member><parameter>scale</parameter> is outside the valid range</member>
+   </simplelist>
+  </para>
+ </refsect1>
+
  <refsect1 role="changelog">
   &reftitle.changelog;
   <informaltable>

diff --git a/reference/bc/functions/bcceil.xml b/reference/bc/functions/bcceil.xml
@@ -39,6 +39,17 @@
   </simpara>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   This function throws a <exceptionname>ValueError</exceptionname> in the following cases:
+   <simplelist>
+    <member><parameter>num</parameter> is not a well-formed BCMath numeric string</member>
+    <member><parameter>scale</parameter> is outside the valid range</member>
+   </simplelist>
+  </para>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <example>

diff --git a/reference/bc/functions/bccomp.xml b/reference/bc/functions/bccomp.xml
@@ -58,12 +58,23 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns 0 if the two operands are equal, 1 if the
+   Returns <literal>0</literal> if the two operands are equal, <literal>1</literal> if the
    <parameter>num1</parameter> is larger than the 
-   <parameter>num2</parameter>, -1 otherwise.
+   <parameter>num2</parameter>, <literal>-1</literal> otherwise.
   </para>
  </refsect1>
-
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   This function throws a <exceptionname>ValueError</exceptionname> in the following cases:
+   <simplelist>
+    <member><parameter>num1</parameter> or <parameter>num2</parameter> is not a well-formed BCMath numeric string</member>
+    <member><parameter>scale</parameter> is outside the valid range</member>
+   </simplelist>
+  </para>
+ </refsect1>
+
  <refsect1 role="changelog">
   &reftitle.changelog;
   <informaltable>

diff --git a/reference/bc/functions/bcdiv.xml b/reference/bc/functions/bcdiv.xml
@@ -87,7 +87,7 @@
      <row>
       <entry>8.0.0</entry>
       <entry>
-       Dividing by 0 now throws a <exceptionname>DivisionByZeroError</exceptionname> exception instead of returning null.
+       Dividing by <literal>0</literal> now throws a <exceptionname>DivisionByZeroError</exceptionname> exception instead of returning null.
       </entry>
      </row>
     </tbody>

diff --git a/reference/bc/functions/bcfloor.xml b/reference/bc/functions/bcfloor.xml
@@ -39,6 +39,17 @@
   </simpara>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   This function throws a <exceptionname>ValueError</exceptionname> in the following cases:
+   <simplelist>
+    <member><parameter>num</parameter> is not a well-formed BCMath numeric string</member>
+    <member><parameter>scale</parameter> is outside the valid range</member>
+   </simplelist>
+  </para>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
   <example>

diff --git a/reference/bc/functions/bcmod.xml b/reference/bc/functions/bcmod.xml
@@ -89,7 +89,7 @@
      <row>
       <entry>8.0.0</entry>
       <entry>
-       Dividing by 0 now throws a <exceptionname>DivisionByZeroError</exceptionname> exception instead of returning null.
+       Dividing by <literal>0</literal> now throws a <exceptionname>DivisionByZeroError</exceptionname> exception instead of returning null.
       </entry>
      </row>
      <row>

diff --git a/reference/bc/functions/bcmul.xml b/reference/bc/functions/bcmul.xml
@@ -51,7 +51,18 @@
    Returns the result as a string.
   </para>
  </refsect1>
-
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   This function throws a <exceptionname>ValueError</exceptionname> in the following cases:
+   <simplelist>
+    <member><parameter>num1</parameter> or <parameter>num2</parameter> is not a well-formed BCMath numeric string</member>
+    <member><parameter>scale</parameter> is outside the valid range</member>
+   </simplelist>
+  </para>
+ </refsect1>
+
  <refsect1 role="changelog"><!-- {{{ -->
   &reftitle.changelog;
   <informaltable>

diff --git a/reference/bc/functions/bcpow.xml b/reference/bc/functions/bcpow.xml
@@ -84,7 +84,7 @@
      <row>
       <entry>8.4.0</entry>
       <entry>
-       Negative powers of 0 previously returned 0, but now throw a <exceptionname>DivisionByZeroError</exceptionname>
+       Negative powers of <literal>0</literal> previously returned 0, but now throw a <exceptionname>DivisionByZeroError</exceptionname>
        exception.
       </entry>
      </row>

diff --git a/reference/bc/functions/bcpowmod.xml b/reference/bc/functions/bcpowmod.xml
@@ -59,11 +59,27 @@
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
   <para>
-   Returns the result as a string, or &false; if <parameter>modulus</parameter>
-   is <literal>0</literal> or <parameter>exponent</parameter> is negative.
+   Returns the result as a string.
   </para>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   This function throws a <exceptionname>ValueError</exceptionname> in the following cases:
+   <simplelist>
+    <member><parameter>num</parameter>, <parameter>exponent</parameter> or <parameter>modulus</parameter> is not a well-formed BCMath numeric string</member>
+    <member><parameter>num</parameter>, <parameter>exponent</parameter> or <parameter>modulus</parameter> has a fractional part</member>
+    <member><parameter>scale</parameter> is outside the valid range</member>
+    <member><parameter>exponent</parameter> is a negative value</member>
+   </simplelist>
+  </para>
+  <simpara>
+   This function throws a <exceptionname>DivisionByZeroError</exceptionname> exception if <parameter>modulus</parameter>
+   is <literal>0</literal>.
+  </simpara>
+ </refsect1>
+
  <refsect1 role="changelog">
   &reftitle.changelog;
   <informaltable>
@@ -81,6 +97,18 @@
        <parameter>scale</parameter> is now nullable.
       </entry>
      </row>
+     <row>
+      <entry>8.0.0</entry>
+      <entry>
+       Now throws a <exceptionname>ValueError</exceptionname> instead of returning &false; if <parameter>exponent</parameter> is a negative value.
+      </entry>
+     </row>
+     <row>
+      <entry>8.0.0</entry>
+      <entry>
+       Dividing by <literal>0</literal> now throws a <exceptionname>DivisionByZeroError</exceptionname> exception instead of returning &false;.
+      </entry>
+     </row>
     </tbody>
    </tgroup>
   </informaltable>

diff --git a/reference/bc/functions/bcround.xml b/reference/bc/functions/bcround.xml
@@ -45,6 +45,17 @@
   </simpara>
  </refsect1>
 
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   This function throws a <exceptionname>ValueError</exceptionname> in the following cases:
+   <simplelist>
+    <member><parameter>num</parameter> is not a well-formed BCMath numeric string</member>
+    <member><parameter>scale</parameter> is outside the valid range</member>
+   </simplelist>
+  </para>
+ </refsect1>
+
  <refsect1 role="examples">
   &reftitle.examples;
    <example>

diff --git a/reference/bc/functions/bcscale.xml b/reference/bc/functions/bcscale.xml
@@ -47,7 +47,15 @@
    Returns the old scale when used as setter. Otherwise the current scale is returned.
   </para>
  </refsect1>
-
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <simpara>
+   This function throws a <exceptionname>ValueError</exceptionname> if <parameter>scale</parameter>
+   is outside the valid range.
+  </simpara>
+ </refsect1>
+
  <refsect1 role="changelog">
   &reftitle.changelog;
   <informaltable>

diff --git a/reference/bc/functions/bcsub.xml b/reference/bc/functions/bcsub.xml
@@ -51,7 +51,18 @@
    The result of the subtraction, as a string.
   </para>
  </refsect1>
-
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   This function throws a <exceptionname>ValueError</exceptionname> in the following cases:
+   <simplelist>
+    <member><parameter>num1</parameter> or <parameter>num2</parameter> is not a well-formed BCMath numeric string</member>
+    <member><parameter>scale</parameter> is outside the valid range</member>
+   </simplelist>
+  </para>
+ </refsect1>
+
  <refsect1 role="changelog">
   &reftitle.changelog;
   <informaltable>