[doc-en] master: ftp: document the ValueError for an invalid transfer mode (#6037)

Author: Raphael Fakhri (RaphaelFakhri) Committer: GitHub (web-flow) Pusher: lacatoire Date: 2026-11-08T18:47:30+01:00 Commit: https://github.com/php/doc-en/commit/3823de9ad7361e67b681f0dfca3a03c2d6b6e849 Raw diff: https://github.com/php/doc-en/commit/3823de9ad7361e67b681f0dfca3a03c2d6b6e849.diff ftp: document the ValueError for an invalid transfer mode (#6037) * ftp: document the ValueError for an invalid transfer mode * ftp: move the ValueError changelog row into an entity Changed paths: A reference/ftp/entities.ent M reference/ftp/functions/ftp-append.xml M reference/ftp/functions/ftp-fget.xml M reference/ftp/functions/ftp-fput.xml M reference/ftp/functions/ftp-get.xml M reference/ftp/functions/ftp-nb-fget.xml M reference/ftp/functions/ftp-nb-fput.xml M reference/ftp/functions/ftp-nb-get.xml M reference/ftp/functions/ftp-nb-put.xml M reference/ftp/functions/ftp-put.xml Diff: diff --git a/reference/ftp/entities.ent b/reference/ftp/entities.ent new file mode 100644 index 000000000000..f01bd6a4baef --- /dev/null +++ b/reference/ftp/entities.ent @@ -0,0 +1,33 @@ +<?xml version="1.0" encoding="utf-8"?> +<!-- $Revision$ --> +<!-- + See manual.xml for XML namespaces defaults. + Keep the lines under 79 columns, to make the process of manual + translation easier, and to avoid wrap-around in some other contexts. +--> +<entities xmlns = "http://docbook.org/ns/docbook" + xmlns:xlink = "http://www.w3.org/1999/xlink" + translate = "yes"> + +<entity name="ext.ftp.changelog.mode-valueerror"> + <row> + <entry>8.0.0</entry> + <entry> + Now throws a <exceptionname>ValueError</exceptionname> if + <parameter>mode</parameter> is not <constant>FTP_ASCII</constant> or + <constant>FTP_BINARY</constant>. + Previously, an <constant>E_WARNING</constant> was raised and &false; + was returned. + </entry> + </row> +</entity> + +<entity name="ext.ftp.mode-valueerror"> + <simpara> + Throws a <exceptionname>ValueError</exceptionname> if + <parameter>mode</parameter> is not <constant>FTP_ASCII</constant> or + <constant>FTP_BINARY</constant>. + </simpara> +</entity> + +</entities> diff --git a/reference/ftp/functions/ftp-append.xml b/reference/ftp/functions/ftp-append.xml index 274e9f5c86d6..826316757e12 100644 --- a/reference/ftp/functions/ftp-append.xml +++ b/reference/ftp/functions/ftp-append.xml @@ -66,6 +66,11 @@ </simpara> </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + &ext.ftp.mode-valueerror; + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <informaltable> @@ -78,6 +83,7 @@ </thead> <tbody> &ftp.changelog.ftp-param; + &ext.ftp.changelog.mode-valueerror; </tbody> </tgroup> </informaltable> diff --git a/reference/ftp/functions/ftp-fget.xml b/reference/ftp/functions/ftp-fget.xml index 8cdbcb6ae531..991dc8487b01 100644 --- a/reference/ftp/functions/ftp-fget.xml +++ b/reference/ftp/functions/ftp-fget.xml @@ -73,6 +73,11 @@ </para> </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + &ext.ftp.mode-valueerror; + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <informaltable> @@ -85,6 +90,7 @@ </thead> <tbody> &ftp.changelog.ftp-param; + &ext.ftp.changelog.mode-valueerror; <row> <entry>7.3.0</entry> <entry> diff --git a/reference/ftp/functions/ftp-fput.xml b/reference/ftp/functions/ftp-fput.xml index 7e004cc5feb6..3526aa30ad1b 100644 --- a/reference/ftp/functions/ftp-fput.xml +++ b/reference/ftp/functions/ftp-fput.xml @@ -71,6 +71,11 @@ </para> </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + &ext.ftp.mode-valueerror; + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <informaltable> @@ -83,6 +88,7 @@ </thead> <tbody> &ftp.changelog.ftp-param; + &ext.ftp.changelog.mode-valueerror; <row> <entry>7.3.0</entry> <entry> diff --git a/reference/ftp/functions/ftp-get.xml b/reference/ftp/functions/ftp-get.xml index f19b81b46010..ed1c2301355b 100644 --- a/reference/ftp/functions/ftp-get.xml +++ b/reference/ftp/functions/ftp-get.xml @@ -73,6 +73,11 @@ </para> </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + &ext.ftp.mode-valueerror; + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <informaltable> @@ -85,6 +90,7 @@ </thead> <tbody> &ftp.changelog.ftp-param; + &ext.ftp.changelog.mode-valueerror; <row> <entry>7.3.0</entry> <entry> diff --git a/reference/ftp/functions/ftp-nb-fget.xml b/reference/ftp/functions/ftp-nb-fget.xml index 51bbc5809616..4ac2d8e1712c 100644 --- a/reference/ftp/functions/ftp-nb-fget.xml +++ b/reference/ftp/functions/ftp-nb-fget.xml @@ -77,6 +77,11 @@ </para> </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + &ext.ftp.mode-valueerror; + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <informaltable> @@ -89,6 +94,7 @@ </thead> <tbody> &ftp.changelog.ftp-param; + &ext.ftp.changelog.mode-valueerror; <row> <entry>7.3.0</entry> <entry> diff --git a/reference/ftp/functions/ftp-nb-fput.xml b/reference/ftp/functions/ftp-nb-fput.xml index e9a4baa0aa44..a1d40b66afa5 100644 --- a/reference/ftp/functions/ftp-nb-fput.xml +++ b/reference/ftp/functions/ftp-nb-fput.xml @@ -77,6 +77,11 @@ </para> </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + &ext.ftp.mode-valueerror; + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <informaltable> @@ -89,6 +94,7 @@ </thead> <tbody> &ftp.changelog.ftp-param; + &ext.ftp.changelog.mode-valueerror; <row> <entry>7.3.0</entry> <entry> diff --git a/reference/ftp/functions/ftp-nb-get.xml b/reference/ftp/functions/ftp-nb-get.xml index 6aa59145fbd9..844b954d7c85 100644 --- a/reference/ftp/functions/ftp-nb-get.xml +++ b/reference/ftp/functions/ftp-nb-get.xml @@ -77,6 +77,11 @@ </para> </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + &ext.ftp.mode-valueerror; + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <informaltable> @@ -89,6 +94,7 @@ </thead> <tbody> &ftp.changelog.ftp-param; + &ext.ftp.changelog.mode-valueerror; <row> <entry>7.3.0</entry> <entry> diff --git a/reference/ftp/functions/ftp-nb-put.xml b/reference/ftp/functions/ftp-nb-put.xml index b92515ee5406..6fbcd3f2a55c 100644 --- a/reference/ftp/functions/ftp-nb-put.xml +++ b/reference/ftp/functions/ftp-nb-put.xml @@ -76,6 +76,11 @@ </para> </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + &ext.ftp.mode-valueerror; + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <informaltable> @@ -88,6 +93,7 @@ </thead> <tbody> &ftp.changelog.ftp-param; + &ext.ftp.changelog.mode-valueerror; <row> <entry>7.3.0</entry> <entry> diff --git a/reference/ftp/functions/ftp-put.xml b/reference/ftp/functions/ftp-put.xml index 29ab7e687b02..732f4f4a0279 100644 --- a/reference/ftp/functions/ftp-put.xml +++ b/reference/ftp/functions/ftp-put.xml @@ -70,6 +70,11 @@ </para> </refsect1> + <refsect1 role="errors"> + &reftitle.errors; + &ext.ftp.mode-valueerror; + </refsect1> + <refsect1 role="changelog"> &reftitle.changelog; <informaltable> @@ -82,6 +87,7 @@ </thead> <tbody> &ftp.changelog.ftp-param; + &ext.ftp.changelog.mode-valueerror; <row> <entry>7.3.0</entry> <entry>