From 54f83f3640373a05891621db40a758490225a2f8 Mon Sep 17 00:00:00 2001
From: George Peter Banyard <girgias@php.net>
Date: Tue, 26 Sep 2023 20:29:29 +0100
Subject: [PATCH 1/2] Document str_increment() and str_decrement()

---
 reference/strings/functions/str-decrement.xml | 135 ++++++++++++++++++
 reference/strings/functions/str-increment.xml | 131 +++++++++++++++++
 reference/strings/versions.xml                |   2 +
 3 files changed, 268 insertions(+)
 create mode 100644 reference/strings/functions/str-decrement.xml
 create mode 100644 reference/strings/functions/str-increment.xml

diff --git a/reference/strings/functions/str-decrement.xml b/reference/strings/functions/str-decrement.xml
new file mode 100644
index 000000000000..2f73da230098
--- /dev/null
+++ b/reference/strings/functions/str-decrement.xml
@@ -0,0 +1,135 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.str-decrement">
+ <refnamediv>
+  <refname>str_decrement</refname>
+  <refpurpose>Decrement an alphanumeric string</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>string</type><methodname>str_decrement</methodname>
+   <methodparam><type>string</type><parameter>string</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Returns the decremented alphanumeric <acronym>ASCII</acronym>
+   <parameter>string</parameter>.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>string</parameter></term>
+     <listitem>
+      <para>
+       The input string.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the decremented alphanumeric <acronym>ASCII</acronym> string.
+  </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   A <classname>ValueError</classname> is thrown if
+   <parameter>string</parameter> is empty.
+  </para>
+  <para>
+   A <classname>ValueError</classname> is thrown if
+   <parameter>string</parameter> is not an alphanumeric
+   <acronym>ASCII</acronym> string.
+  </para>
+  <para>
+   A <classname>ValueError</classname> is thrown if
+   <parameter>string</parameter> is out of the decrement range.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>Basic <function>str_decrement</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$str = 'ABC';
+var_dump(str_decrement($str));
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+string(3) "ABB"
+]]>
+    </screen>
+   </example>
+  </para>
+  <para>
+   <example>
+    <title><function>str_decrement</function> example with a carry</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$str = 'ZA';
+var_dump(str_decrement($str));
+
+$str = 'AA';
+var_dump(str_decrement($str));
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+string(2) "YZ"
+string(1) "Z"
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>str_increment</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+
+</refentry>
+<!-- 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
+-->
diff --git a/reference/strings/functions/str-increment.xml b/reference/strings/functions/str-increment.xml
new file mode 100644
index 000000000000..af5049302f12
--- /dev/null
+++ b/reference/strings/functions/str-increment.xml
@@ -0,0 +1,131 @@
+<?xml version="1.0" encoding="utf-8"?>
+<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.str-increment">
+ <refnamediv>
+  <refname>str_increment</refname>
+  <refpurpose>Increment an alphanumeric string</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>string</type><methodname>str_increment</methodname>
+   <methodparam><type>string</type><parameter>string</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   Returns the incremented alphanumeric <acronym>ASCII</acronym>
+   <parameter>string</parameter>.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>string</parameter></term>
+     <listitem>
+      <para>
+       The input string.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns the incremented alphanumeric <acronym>ASCII</acronym> string.
+  </para>
+ </refsect1>
+
+ <refsect1 role="errors">
+  &reftitle.errors;
+  <para>
+   A <classname>ValueError</classname> is thrown if
+   <parameter>string</parameter> is empty.
+  </para>
+  <para>
+   A <classname>ValueError</classname> is thrown if
+   <parameter>string</parameter> is not an alphanumeric
+   <acronym>ASCII</acronym> string.
+  </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+  &reftitle.examples;
+  <para>
+   <example>
+    <title>Basic <function>str_increment</function> example</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$str = 'ABC';
+var_dump(str_increment($str));
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+string(3) "ABD"
+]]>
+    </screen>
+   </example>
+  </para>
+  <para>
+   <example>
+    <title><function>str_increment</function> example with a carry</title>
+    <programlisting role="php">
+<![CDATA[
+<?php
+$str = 'DZ';
+var_dump(str_increment($str));
+
+$str = 'ZZ';
+var_dump(str_increment($str));
+?>
+]]>
+    </programlisting>
+    &example.outputs;
+    <screen>
+<![CDATA[
+string(2) "EA"
+string(3) "AAA"
+]]>
+    </screen>
+   </example>
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>str_decrement</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+
+</refentry>
+<!-- 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
+-->
diff --git a/reference/strings/versions.xml b/reference/strings/versions.xml
index bf165edcdfe2..469c11f82b7f 100644
--- a/reference/strings/versions.xml
+++ b/reference/strings/versions.xml
@@ -56,9 +56,11 @@
  <function name="sprintf" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
  <function name="sscanf" from="PHP 4 &gt;= 4.0.1, PHP 5, PHP 7, PHP 8"/>
  <function name="str_contains" from="PHP 8"/>
+ <function name="str_decrement" from="PHP 8 &gt;= 8.3.0"/>
  <function name="str_ends_with" from="PHP 8"/>
  <function name="str_getcsv" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
  <function name="str_ireplace" from="PHP 5, PHP 7, PHP 8"/>
+ <function name="str_increment" from="PHP 8 &gt;= 8.3.0"/>
  <function name="str_pad" from="PHP 4 &gt;= 4.0.1, PHP 5, PHP 7, PHP 8"/>
  <function name="str_repeat" from="PHP 4, PHP 5, PHP 7, PHP 8"/>
  <function name="str_replace" from="PHP 4, PHP 5, PHP 7, PHP 8"/>

From 7be23ed2854c81de7f0a1775f910bd7a04635e4f Mon Sep 17 00:00:00 2001
From: George Peter Banyard <girgias@php.net>
Date: Thu, 5 Oct 2023 01:14:57 +0100
Subject: [PATCH 2/2] Describe decrement range value error better

---
 reference/strings/functions/str-decrement.xml | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/reference/strings/functions/str-decrement.xml b/reference/strings/functions/str-decrement.xml
index 2f73da230098..07933ae75c3d 100644
--- a/reference/strings/functions/str-decrement.xml
+++ b/reference/strings/functions/str-decrement.xml
@@ -53,7 +53,8 @@
   </para>
   <para>
    A <classname>ValueError</classname> is thrown if
-   <parameter>string</parameter> is out of the decrement range.
+   <parameter>string</parameter> cannot be decremented.
+   For example, <literal>"A"</literal> or <literal>"0"</literal>.
   </para>
  </refsect1>