[doc-en] master: Session upload progress: switch to `<simpara>` for docbook-cs
| From: | Daniel Scherzer | Date: | Sat, 26 Sep 2026 00:21:10 +0000 |
| Subject: | [doc-en] master: Session upload progress: switch to `<simpara>` for docbook-cs | ||
| Groups: | php.doc.cvs | ||
| Request: | Send a blank email to doc-cvs+get-23778@lists.php.net to get a copy of this message | ||
Author: Daniel Scherzer (DanielEScherzer)
Date: 2026-09-25T15:52:04-07:00
Commit: https://github.com/php/doc-en/commit/b233df848d6c4297cb72845bbfc88cbe96833d65
Raw diff: https://github.com/php/doc-en/commit/b233df848d6c4297cb72845bbfc88cbe96833d65.diff
Session upload progress: switch to
<simpara> for docbook-cs
Changed paths:
M reference/session/upload-progress.xml
Diff:
diff --git a/reference/session/upload-progress.xml b/reference/session/upload-progress.xml
index 085fe53c68bb..b1f55cab5740 100644
--- a/reference/session/upload-progress.xml
+++ b/reference/session/upload-progress.xml
@@ -4,7 +4,7 @@
<chapter xml:id="session.upload-progress" xmlns="http://docbook.org/ns/docbook"
xmlns:xlink="http://www.w3.org/1999/xlink">
<title>Session Upload Progress</title>
- <para>
+ <simpara>
When the
<link
linkend="ini.session.upload-progress.enabled">session.upload_progress.enabled</link>
INI option is enabled, PHP will be able to track the upload progress of
@@ -13,7 +13,7 @@
itself, but during the file upload an application can send a POST request
to a separate endpoint (via <acronym>XHR</acronym> for example) to check the
status.
- </para>
+ </simpara>
<para>
The upload progress will be available in the <varname>$_SESSION</varname>
superglobal when an upload is in progress, and when POSTing a variable of
@@ -38,7 +38,7 @@ var_dump($_SESSION[$key]);
</programlisting>
</informalexample>
</para>
- <para>
+ <simpara>
It is also possible to <emphasis>cancel</emphasis> the currently in-progress file
upload, by setting the <literal>$_SESSION[$key]["cancel_upload"]</literal>
key to
&true;.
@@ -48,8 +48,8 @@ var_dump($_SESSION[$key]);
When an upload is cancelled like this, the <literal>error</literal> key in
<varname>$_FILES</varname> array will be set to
<constant>UPLOAD_ERR_EXTENSION</constant>.
- </para>
- <para>
+ </simpara>
+ <simpara>
The
<link
linkend="ini.session.upload-progress.freq">session.upload_progress.freq</link>
and
@@ -58,13 +58,13 @@ var_dump($_SESSION[$key]);
recalculated.
With a reasonable amount for these two settings, the overhead of this
feature is almost non-existent.
- </para>
+ </simpara>
<para>
<example>
<title>Example information</title>
- <para>
+ <simpara>
Example of the structure of the progress upload array.
- </para>
+ </simpara>
<programlisting role="html"
xml:id="session.upload-progress.example-form">
<![CDATA[
<form action="upload.php" method="POST"
enctype="multipart/form-data">
@@ -75,9 +75,9 @@ var_dump($_SESSION[$key]);
</form>
]]>
</programlisting>
- <para>
+ <simpara>
The data stored in the session will look like this:
- </para>
+ </simpara>
<programlisting role="php"
xml:id="session.upload-progress.example-array">
<![CDATA[
<?php
@@ -114,19 +114,19 @@ $_SESSION["upload_progress_123"] = array(
</example>
</para>
<warning>
- <para>
+ <simpara>
The web server's request buffering has to be disabled for this to work
properly, else PHP may see the file upload only once fully uploaded. Servers
such as Nginx are known to buffer larger requests.
- </para>
+ </simpara>
</warning>
<caution>
- <para>
+ <simpara>
The upload progress information is written to the session before any scripts
are executed. Therefore changing the session name via <function>ini_set</function>
or <function>session_name</function> will give a session without the upload
progress information.
- </para>
+ </simpara>
</caution>
</chapter>