8.3: Document Random\IntervalBoundary (#3419)

Closes #3074 

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

Author: Girgias

reference/random/book.xml

@@ -16,6 +16,7 @@
  &reference.random.reference;
 
  &reference.random.random.randomizer;
+ &reference.random.random.intervalboundary;
 
  &reference.random.random.engine;
  &reference.random.random.cryptosafeengine;

reference/random/random.intervalboundary.xml

@@ -0,0 +1,79 @@
+<?xml version="1.0" encoding="utf-8"?>
+<reference xmlns="http://docbook.org/ns/docbook" xml:id="enum.random.intervalboundary" role="enum">
+ <title>The Random\IntervalBoundary Enum</title>
+ <titleabbrev>Random\IntervalBoundary</titleabbrev>
+
+ <partintro>
+  <section xml:id="enum.random.intervalboundary.intro">
+   &reftitle.intro;
+   <simpara>
+    The <enumname>Random\IntervalBoundary</enumname> enum specifies
+    whether an interval includes the boundary values within the set of values
+    lying in the interval.
+   </simpara>
+  </section>
+
+  <section xml:id="enum.random.intervalboundary.synopsis">
+   &reftitle.enumsynopsis;
+
+   <enumsynopsis>
+    <enumname>Random\IntervalBoundary</enumname>
+
+    <enumitem>
+     <enumidentifier>ClosedOpen</enumidentifier>
+     <enumitemdescription>
+      A left-open interval.
+      The lower boundary is included in the interval,
+      the upper boundary is not.
+     </enumitemdescription>
+    </enumitem>
+
+    <enumitem>
+     <enumidentifier>ClosedClosed</enumidentifier>
+     <enumitemdescription>
+      A closed interval.
+      Both boundary values are included in the interval.
+     </enumitemdescription>
+    </enumitem>
+
+    <enumitem>
+     <enumidentifier>OpenClosed</enumidentifier>
+     <enumitemdescription>
+      A right-open interval.
+      The upper boundary is included in the interval,
+      the lower boundary is not.
+     </enumitemdescription>
+    </enumitem>
+
+    <enumitem>
+     <enumidentifier>OpenOpen</enumidentifier>
+     <enumitemdescription>
+      An open interval.
+      Neither boundary value is included in the interval.
+     </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/random/versions.xml

@@ -95,6 +95,9 @@
  <function name='random\randomizer::getbytesfromstring' from='PHP 8 &gt;= 8.3.0'/>
  <function name='random\randomizer::getfloat' from='PHP 8 &gt;= 8.3.0'/>
  <function name='random\randomizer::nextfloat' from='PHP 8 &gt;= 8.3.0'/>
+
+ <!-- RoundingMode enum -->
+ <function name='random\intervalboundary' from='PHP 8 &gt;= 8.3.0'/>
 </versions>
 <!-- Keep this comment at the end of the file
 Local variables: