PHP 8.4: Document RoundingMode (#4080)

Co-authored-by: Tim Düsterhus <[email protected]>

Author: Girgias

reference/math/book.xml

@@ -1,6 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-
 <book xml:id="book.math" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
  <?phpdoc extension-membership="core" ?>
  <title>Mathematical Functions</title>
@@ -37,10 +36,10 @@
  <!-- }}} -->
 
  &reference.math.constants;
+ &reference.math.roundingmode;
  &reference.math.reference;
 
 </book>
-
 <!-- Keep this comment at the end of the file
 Local variables:
 mode: sgml

reference/math/roundingmode.xml

@@ -0,0 +1,109 @@
+<?xml version="1.0" encoding="utf-8"?>
+<reference xmlns="http://docbook.org/ns/docbook" xml:id="enum.roundingmode" role="enum">
+ <title>The RoundingMode Enum</title>
+ <titleabbrev>RoundingMode</titleabbrev>
+
+ <partintro>
+  <section xml:id="enum.roundingmode.intro">
+   &reftitle.intro;
+   <simpara>
+    The <enumname>RoundingMode</enumname> enum is used to specify how rounding
+    should be performed for <function>round</function>,
+    <function>bcround</function>, and <methodname>BCMath::round</methodname>.
+   </simpara>
+  </section>
+
+  <section xml:id="enum.roundingmode.synopsis">
+   &reftitle.enumsynopsis;
+
+   <enumsynopsis>
+    <enumname>RoundingMode</enumname>
+
+    <enumitem>
+     <enumidentifier>HalfAwayFromZero</enumidentifier>
+     <enumitemdescription>
+      Round to the nearest integer.
+      If the decimal part is <literal>5</literal>,
+      round to the integer with the larger absolute value.
+     </enumitemdescription>
+    </enumitem>
+
+    <enumitem>
+     <enumidentifier>HalfTowardsZero</enumidentifier>
+     <enumitemdescription>
+      Round to the nearest integer.
+      If the decimal part is <literal>5</literal>,
+      round to the integer with the smaller absolute value.
+     </enumitemdescription>
+    </enumitem>
+
+    <enumitem>
+     <enumidentifier>HalfEven</enumidentifier>
+     <enumitemdescription>
+      Round to the nearest integer.
+      If the decimal part is <literal>5</literal>,
+      round to the even integer.
+     </enumitemdescription>
+    </enumitem>
+
+    <enumitem>
+     <enumidentifier>HalfOdd</enumidentifier>
+     <enumitemdescription>
+      Round to the nearest integer.
+      If the decimal part is <literal>5</literal>,
+      round to the odd integer.
+     </enumitemdescription>
+    </enumitem>
+
+    <enumitem>
+     <enumidentifier>TowardsZero</enumidentifier>
+     <enumitemdescription>
+      Round to the nearest integer with a smaller or equal absolute value.
+     </enumitemdescription>
+    </enumitem>
+
+    <enumitem>
+     <enumidentifier>AwayFromZero</enumidentifier>
+     <enumitemdescription>
+      Round to the nearest integer with a greater or equal absolute value.
+     </enumitemdescription>
+    </enumitem>
+
+    <enumitem>
+     <enumidentifier>NegativeInfinity</enumidentifier>
+     <enumitemdescription>
+      Round to the largest integer that is smaller or equal.
+     </enumitemdescription>
+    </enumitem>
+
+    <enumitem>
+     <enumidentifier>PositiveInfinity</enumidentifier>
+     <enumitemdescription>
+      Round to the smallest integer that is greater or equal.
+     </enumitemdescription>
+    </enumitem>
+
+   </enumsynopsis>
+  </section>
+ </partintro>
+</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
+-->

reference/math/versions.xml

@@ -48,6 +48,9 @@
  <function name="tan" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
  <function name="tanh" from="PHP 4 &gt;= 4.1.0, PHP 5, PHP 7, PHP 8"/>
  <function name="intdiv" from="PHP 7, PHP 8"/>
+
+ <!-- RoundingMode -->
+ <function name="roundingmode" from="PHP 8 &gt;= 8.4.0"/>
 </versions>
 <!-- Keep this comment at the end of the file
 Local variables: