[DOC-CVS] [doc-en] master: luasandbox: fix XML by converting para to simpara tags via script
[email protected] (Gina Peter Banyard)
| Newsgroups | php.doc.cvs |
|---|---|
| Message-ID | <[email protected]> |
Author: Gina Peter Banyard (Girgias)
Date: 2026-01-19T02:53:26Z
Commit: https://github.com/php/doc-en/commit/9c40251a81d8f369c184e83fd142c4cc656a7261
Raw diff: https://github.com/php/doc-en/commit/9c40251a81d8f369c184e83fd142c4cc656a7261.diff
luasandbox: fix XML by converting para to simpara tags via script
Changed paths:
M reference/luasandbox/book.xml
M reference/luasandbox/configure.xml
M reference/luasandbox/differences.xml
M reference/luasandbox/examples.xml
M reference/luasandbox/luasandbox.xml
M reference/luasandbox/luasandbox/callfunction.xml
M reference/luasandbox/luasandbox/disableprofiler.xml
M reference/luasandbox/luasandbox/enableprofiler.xml
M reference/luasandbox/luasandbox/getcpuusage.xml
M reference/luasandbox/luasandbox/getmemoryusage.xml
M reference/luasandbox/luasandbox/getpeakmemoryusage.xml
M reference/luasandbox/luasandbox/getprofilerfunctionreport.xml
M reference/luasandbox/luasandbox/getversioninfo.xml
M reference/luasandbox/luasandbox/loadbinary.xml
M reference/luasandbox/luasandbox/loadstring.xml
M reference/luasandbox/luasandbox/pauseusagetimer.xml
M reference/luasandbox/luasandbox/registerlibrary.xml
M reference/luasandbox/luasandbox/setcpulimit.xml
M reference/luasandbox/luasandbox/setmemorylimit.xml
M reference/luasandbox/luasandbox/unpauseusagetimer.xml
M reference/luasandbox/luasandbox/wrapphpfunction.xml
M reference/luasandbox/luasandboxerror.xml
M reference/luasandbox/luasandboxerrorerror.xml
M reference/luasandbox/luasandboxfatalerror.xml
M reference/luasandbox/luasandboxfunction.xml
M reference/luasandbox/luasandboxfunction/call.xml
M reference/luasandbox/luasandboxfunction/construct.xml
M reference/luasandbox/luasandboxfunction/dump.xml
M reference/luasandbox/luasandboxmemoryerror.xml
M reference/luasandbox/luasandboxruntimeerror.xml
M reference/luasandbox/luasandboxsyntaxerror.xml
M reference/luasandbox/luasandboxtimeouterror.xml
M reference/luasandbox/setup.xml
Diff:
diff --git a/reference/luasandbox/book.xml b/reference/luasandbox/book.xml
index 1995bf44ab0d..7e32d0fe2bc6 100644
--- a/reference/luasandbox/book.xml
+++ b/reference/luasandbox/book.xml
@@ -1,46 +1,45 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<book xml:id="book.luasandbox" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.luasandbox">
<?phpdoc extension-membership="pecl" ?>
<title>LuaSandbox</title>
<titleabbrev>LuaSandbox</titleabbrev>
<preface xml:id="intro.luasandbox">
&reftitle.intro;
- <para>
+ <simpara>
LuaSandbox is an extension for PHP 7 and PHP 8 to allow safely
running untrusted Lua 5.1 code from within PHP.
- </para>
+ </simpara>
<para>
Differences compared to the <link linkend="book.lua">Lua</link> extension:
<itemizedlist>
<listitem>
- <para>
+ <simpara>
LuaSandbox has support for time and memory limits.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
LuaSandbox provides a default-safe environment for running untrusted code.
Stock Lua functions were reviewed for security, and several were patched
accordingly.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
LuaSandbox has a PHP interface which is more complex, precise and powerful,
but it is less convenient for developers.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
LuaSandbox supports only Lua 5.1. It is difficult to change this, because
LuaSandbox uses heavily modified Lua standard libraries, and
due to the lack of backwards compatibility between major Lua versions.
LuaSandbox aims to maximise backwards compatibility with user-supplied
scripts.
- </para>
+ </simpara>
</listitem>
</itemizedlist>
</para>
@@ -63,7 +62,6 @@
&reference.luasandbox.luasandboxtimeouterror;
</book>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/luasandbox/configure.xml b/reference/luasandbox/configure.xml
index 2eafcea1dce7..eb561590f7ff 100644
--- a/reference/luasandbox/configure.xml
+++ b/reference/luasandbox/configure.xml
@@ -1,17 +1,14 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<section xml:id="luasandbox.installation" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<section xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="luasandbox.installation">
&reftitle.install;
- <para>
+ <simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;luasandbox">&url.pecl.package;luasandbox</link>
- </para>
+ </simpara>
</section>
-
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/luasandbox/differences.xml b/reference/luasandbox/differences.xml
index 9701f276c99c..be344b1a8a83 100644
--- a/reference/luasandbox/differences.xml
+++ b/reference/luasandbox/differences.xml
@@ -3,66 +3,66 @@
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="reference.luasandbox.differences">
<title>Differences from Standard Lua</title>
- <para>
+ <simpara>
LuaSandbox provides a sandboxed environment which differs in some ways from standard Lua 5.1.
- </para>
+ </simpara>
<simplesect xml:id="reference.luasandbox.differences.unavailable">
<title>Features that are not available</title>
<itemizedlist>
<listitem>
- <para>
+ <simpara>
<literal>dofile()</literal>, <literal>loadfile()</literal>, and the <literal>io</literal> package, as they allow direct filesystem access. If needed, filesystem access should be done via PHP callbacks.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
The <literal>package</literal> package, including <literal>require()</literal> and <literal>module()</literal>, as it depends heavily on direct filesystem access. A pure-Lua rewrite such as that used in the MediaWiki Scribunto extension may be used instead.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
<literal>load()</literal> and <literal>loadstring()</literal>, to allow for static analysis of Lua code.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
<literal>print()</literal>, since it outputs to standard output. If needed, output should be done via PHP callbacks.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
Most of the <literal>os</literal> package, as it allows manipulation of the process and executing of other processes.
- </para>
+ </simpara>
<itemizedlist>
<listitem>
- <para>
+ <simpara>
<literal>os.clock()</literal>, <literal>os.date()</literal>, <literal>os.difftime()</literal>, and <literal>os.time()</literal> remain available.
- </para>
+ </simpara>
</listitem>
</itemizedlist>
</listitem>
<listitem>
- <para>
+ <simpara>
Most of the <literal>debug</literal> package, as it allows manipulation of Lua state and metadata in ways that can break sandboxing.
- </para>
+ </simpara>
<itemizedlist>
<listitem>
- <para>
+ <simpara>
<literal>debug.traceback()</literal> remains available.
- </para>
+ </simpara>
</listitem>
</itemizedlist>
</listitem>
<listitem>
- <para>
+ <simpara>
<literal>string.dump()</literal>, as it may expose internal data.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
<literal>collectgarbage()</literal>, <literal>gcinfo()</literal>, and the <literal>coroutine</literal> package have not been reviewed for security.
- </para>
+ </simpara>
</listitem>
</itemizedlist>
</simplesect>
@@ -71,29 +71,29 @@
<title>Features that have been modified</title>
<itemizedlist>
<listitem>
- <para>
+ <simpara>
<literal>pcall()</literal> and <literal>xpcall()</literal> cannot catch certain errors, particularly timeout errors.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
<literal>tostring()</literal> does not include pointer addresses.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
<literal>string.match()</literal> has been patched to limit the recursion depth and to periodically check for a timeout.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
<literal>math.random()</literal> and <literal>math.randomseed()</literal> are replaced with versions that don't share state with PHP's <literal>rand()</literal>.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
The Lua 5.2 <literal>__pairs</literal> and <literal>__ipairs</literal> metamethods are supported by <literal>pairs()</literal> and <literal>ipairs()</literal>.
- </para>
+ </simpara>
</listitem>
</itemizedlist>
</simplesect>
diff --git a/reference/luasandbox/examples.xml b/reference/luasandbox/examples.xml
index 797a2e23a9c7..6dbe9380e56b 100644
--- a/reference/luasandbox/examples.xml
+++ b/reference/luasandbox/examples.xml
@@ -7,9 +7,9 @@
<!-- Make sure each xml:id is unique -->
<section xml:id="luasandbox.examples-basic">
<title>Basic usage for LuaSandbox</title>
- <para>
+ <simpara>
Once you've compiled PHP with LuaSandbox support, you can begin using LuaSandbox to safely run user-provided Lua code.
- </para>
+ </simpara>
<example>
<title>Execute some Lua code</title>
<programlisting role="php" xml:id="luasandbox.examples.uniqueidhere">
diff --git a/reference/luasandbox/luasandbox.xml b/reference/luasandbox/luasandbox.xml
index 026bd2f298bc..a9abd647d5d4 100644
--- a/reference/luasandbox/luasandbox.xml
+++ b/reference/luasandbox/luasandbox.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.luasandbox" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.luasandbox" role="class">
<title>The LuaSandbox class</title>
<titleabbrev>LuaSandbox</titleabbrev>
@@ -11,10 +10,10 @@
<!-- {{{ LuaSandbox intro -->
<section xml:id="luasandbox.intro">
&reftitle.intro;
- <para>
+ <simpara>
The LuaSandbox class creates a Lua environment and allows for execution of
Lua code.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -53,7 +52,7 @@
</fieldsynopsis>
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.luasandbox')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.luasandbox')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -67,27 +66,27 @@
<varlistentry xml:id="luasandbox.constants.samples">
<term><constant>LuaSandbox::SAMPLES</constant></term>
<listitem>
- <para>
+ <simpara>
Used with <methodname>LuaSandbox::getProfilerFunctionReport</methodname> to return timings in samples.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="luasandbox.constants.seconds">
<term><constant>LuaSandbox::SECONDS</constant></term>
<listitem>
- <para>
+ <simpara>
Used with <methodname>LuaSandbox::getProfilerFunctionReport</methodname> to return timings in seconds.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="luasandbox.constants.percent">
<term><constant>LuaSandbox::PERCENT</constant></term>
<listitem>
- <para>
+ <simpara>
Used with <methodname>LuaSandbox::getProfilerFunctionReport</methodname> to return timings in percentages of the total.
- </para>
+ </simpara>
</listitem>
</varlistentry>
@@ -101,7 +100,6 @@
&reference.luasandbox.entities.luasandbox;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/luasandbox/luasandbox/callfunction.xml b/reference/luasandbox/luasandbox/callfunction.xml
index ede7b032afce..1e96f4863b84 100644
--- a/reference/luasandbox/luasandbox/callfunction.xml
+++ b/reference/luasandbox/luasandbox/callfunction.xml
@@ -13,21 +13,21 @@
<methodparam><type>string</type><parameter>name</parameter></methodparam>
<methodparam rep="repeat"><type>mixed</type><parameter>args</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Calls a function in a Lua global variable.
- </para>
- <para>
+ </simpara>
+ <simpara>
If the name contains "." characters, the function is located via
recursive table accesses, as if the name were a Lua expression.
- </para>
- <para>
+ </simpara>
+ <simpara>
If the variable does not exist, or is not a function, false will be
returned and a warning issued.
- </para>
- <para>
+ </simpara>
+ <simpara>
For more information about calling Lua functions and the return values,
see <methodname>LuaSandboxFunction::call</methodname>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -36,17 +36,17 @@
<varlistentry>
<term><parameter>name</parameter></term>
<listitem>
- <para>
+ <simpara>
Lua variable name.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem>
- <para>
+ <simpara>
Arguments to the function.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -54,9 +54,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns an <type>array</type> of values returned by the Lua function, which may be empty, &return.falseforfailure;.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/luasandbox/luasandbox/disableprofiler.xml b/reference/luasandbox/luasandbox/disableprofiler.xml
index b7d7bd12297e..7df8d3af8e42 100644
--- a/reference/luasandbox/luasandbox/disableprofiler.xml
+++ b/reference/luasandbox/luasandbox/disableprofiler.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>void</type><methodname>LuaSandbox::disableProfiler</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Disables the profiler.
- </para>
+ </simpara>
</refsect1>
@@ -25,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
diff --git a/reference/luasandbox/luasandbox/enableprofiler.xml b/reference/luasandbox/luasandbox/enableprofiler.xml
index 412dd0908e27..cc920f65b2ee 100644
--- a/reference/luasandbox/luasandbox/enableprofiler.xml
+++ b/reference/luasandbox/luasandbox/enableprofiler.xml
@@ -12,15 +12,15 @@
<modifier>public</modifier> <type>bool</type><methodname>LuaSandbox::enableProfiler</methodname>
<methodparam choice="opt"><type>float</type><parameter>period</parameter><initializer>0.02</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Enables the profiler. Profiling will begin when Lua code is entered.
- </para>
- <para>
+ </simpara>
+ <simpara>
The profiler periodically samples the Lua environment to record the
running function. Testing indicates that at least on Linux, setting a
period less than 1ms will lead to a high overrun count but no
performance problems.
- </para>
+ </simpara>
</refsect1>
@@ -30,9 +30,9 @@
<varlistentry>
<term><parameter>period</parameter></term>
<listitem>
- <para>
+ <simpara>
Sampling period in seconds.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -40,9 +40,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a boolean indicating whether the profiler is enabled.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
diff --git a/reference/luasandbox/luasandbox/getcpuusage.xml b/reference/luasandbox/luasandbox/getcpuusage.xml
index f53c45d153f4..39282100a4ff 100644
--- a/reference/luasandbox/luasandbox/getcpuusage.xml
+++ b/reference/luasandbox/luasandbox/getcpuusage.xml
@@ -12,12 +12,12 @@
<modifier>public</modifier> <type>float</type><methodname>LuaSandbox::getCPUUsage</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Fetches the current CPU time usage of the Lua environment.
- </para>
- <para>
+ </simpara>
+ <simpara>
This includes time spent in PHP callbacks.
- </para>
+ </simpara>
</refsect1>
@@ -28,16 +28,16 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the current CPU time usage in seconds.
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
On Windows, this function always returns zero. On operating systems that do
not support <constant>CLOCK_THREAD_CPUTIME_ID</constant>, such as FreeBSD
and Mac OS X, this function will return the elapsed wall-clock time, not
CPU time.
- </para>
+ </simpara>
</note>
</refsect1>
diff --git a/reference/luasandbox/luasandbox/getmemoryusage.xml b/reference/luasandbox/luasandbox/getmemoryusage.xml
index 86336d7998b5..1a59767ba5e0 100644
--- a/reference/luasandbox/luasandbox/getmemoryusage.xml
+++ b/reference/luasandbox/luasandbox/getmemoryusage.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>int</type><methodname>LuaSandbox::getMemoryUsage</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Fetches the current memory usage of the Lua environment.
- </para>
+ </simpara>
</refsect1>
@@ -25,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the current memory usage in bytes.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
diff --git a/reference/luasandbox/luasandbox/getpeakmemoryusage.xml b/reference/luasandbox/luasandbox/getpeakmemoryusage.xml
index ec3f11406b40..f152100c800d 100644
--- a/reference/luasandbox/luasandbox/getpeakmemoryusage.xml
+++ b/reference/luasandbox/luasandbox/getpeakmemoryusage.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>int</type><methodname>LuaSandbox::getPeakMemoryUsage</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Fetches the peak memory usage of the Lua environment.
- </para>
+ </simpara>
</refsect1>
@@ -25,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns the peak memory usage in bytes.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
diff --git a/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml b/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml
index c78a9aef1e5a..6301d38a94df 100644
--- a/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml
+++ b/reference/luasandbox/luasandbox/getprofilerfunctionreport.xml
@@ -12,27 +12,27 @@
<modifier>public</modifier> <type>array</type><methodname>LuaSandbox::getProfilerFunctionReport</methodname>
<methodparam choice="opt"><type>int</type><parameter>units</parameter><initializer>LuaSandbox::SECONDS</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
For a profiling instance previously started by
<methodname>LuaSandbox::enableProfiler</methodname>, get a
report of the cost of each function.
- </para>
- <para>
+ </simpara>
+ <simpara>
The measurement unit used for the cost is determined by the
<varname>$units</varname> parameter:
- </para>
+ </simpara>
<variablelist>
<varlistentry>
<term><constant>LuaSandbox::SAMPLES</constant></term>
- <listitem><para>Measure in number of samples.</para></listitem>
+ <listitem><simpara>Measure in number of samples.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><constant>LuaSandbox::SECONDS</constant></term>
- <listitem><para>Measure in seconds of CPU time.</para></listitem>
+ <listitem><simpara>Measure in seconds of CPU time.</simpara></listitem>
</varlistentry>
<varlistentry>
<term><constant>LuaSandbox::PERCENT</constant></term>
- <listitem><para>Measure percentage of CPU time.</para></listitem>
+ <listitem><simpara>Measure percentage of CPU time.</simpara></listitem>
</varlistentry>
</variablelist>
</refsect1>
@@ -43,9 +43,9 @@
<varlistentry>
<term><parameter>units</parameter></term>
<listitem>
- <para>
+ <simpara>
Measurement unit constant.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -53,19 +53,19 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns profiler measurements, sorted in descending order, as an associative
<type>array</type>. Keys are the Lua function names (with source file and line
defined in angle brackets), values are the measurements as <type>int</type>
or <type>float</type>.
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
On Windows, this function always returns an empty array. On operating systems that do
not support <constant>CLOCK_THREAD_CPUTIME_ID</constant>, such as FreeBSD
and Mac OS X, this function will report the elapsed wall-clock time, not
CPU time.
- </para>
+ </simpara>
</note>
</refsect1>
diff --git a/reference/luasandbox/luasandbox/getversioninfo.xml b/reference/luasandbox/luasandbox/getversioninfo.xml
index 0d35d7976279..69d1b7d5ef48 100644
--- a/reference/luasandbox/luasandbox/getversioninfo.xml
+++ b/reference/luasandbox/luasandbox/getversioninfo.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <modifier>static</modifier> <type>array</type><methodname>LuaSandbox::getVersionInfo</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Returns the versions of LuaSandbox and Lua.
- </para>
+ </simpara>
</refsect1>
@@ -25,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns an array with two keys:
- </para>
+ </simpara>
<informaltable>
<tgroup cols="3">
<thead>
diff --git a/reference/luasandbox/luasandbox/loadbinary.xml b/reference/luasandbox/luasandbox/loadbinary.xml
index a38ff86f297d..3be70973a698 100644
--- a/reference/luasandbox/luasandbox/loadbinary.xml
+++ b/reference/luasandbox/luasandbox/loadbinary.xml
@@ -13,9 +13,9 @@
<methodparam><type>string</type><parameter>code</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>chunkName</parameter><initializer>''</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Loads data generated by <methodname>LuaSandboxFunction::dump</methodname>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -24,17 +24,17 @@
<varlistentry>
<term><parameter>code</parameter></term>
<listitem>
- <para>
+ <simpara>
Data from <methodname>LuaSandboxFunction::dump</methodname>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>chunkName</parameter></term>
<listitem>
- <para>
+ <simpara>
Name for the loaded function.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -42,9 +42,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a <classname>LuaSandboxFunction</classname>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
diff --git a/reference/luasandbox/luasandbox/loadstring.xml b/reference/luasandbox/luasandbox/loadstring.xml
index 62025e44f81f..ed71a7fd82f5 100644
--- a/reference/luasandbox/luasandbox/loadstring.xml
+++ b/reference/luasandbox/luasandbox/loadstring.xml
@@ -13,12 +13,12 @@
<methodparam><type>string</type><parameter>code</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>chunkName</parameter><initializer>''</initializer></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Loads Lua code into the Lua environment.
- </para>
- <para>
+ </simpara>
+ <simpara>
This is the equivalent of standard Lua's <literal>loadstring()</literal> function.
- </para>
+ </simpara>
</refsect1>
@@ -28,17 +28,17 @@
<varlistentry>
<term><parameter>code</parameter></term>
<listitem>
- <para>
+ <simpara>
Lua code.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>chunkName</parameter></term>
<listitem>
- <para>
+ <simpara>
Name for the loaded chunk, for use in error traces.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -46,9 +46,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a <classname>LuaSandboxFunction</classname> which, when executed, will execute the passed <varname>$code</varname>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/luasandbox/luasandbox/pauseusagetimer.xml b/reference/luasandbox/luasandbox/pauseusagetimer.xml
index 35f6af4d9f9b..8bf4d7b0fb06 100644
--- a/reference/luasandbox/luasandbox/pauseusagetimer.xml
+++ b/reference/luasandbox/luasandbox/pauseusagetimer.xml
@@ -12,22 +12,22 @@
<modifier>public</modifier> <type>bool</type><methodname>LuaSandbox::pauseUsageTimer</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Pauses the CPU usage timer.
- </para>
- <para>
+ </simpara>
+ <simpara>
This only has effect when called from within a callback from Lua. When
execution returns to Lua, the timer will be automatically unpaused. If
a new call into Lua is made, the timer will be unpaused for the
duration of that call.
- </para>
- <para>
+ </simpara>
+ <simpara>
If a PHP callback calls into Lua again with timer not paused, and then
that Lua function calls into PHP again, the second PHP call will not be
able to pause the timer. The logic is that even though the second PHP
call would avoid counting the CPU usage against the limit, the first
call still counts it.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -37,9 +37,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a <type>bool</type> indicating whether the timer is now paused.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/luasandbox/luasandbox/registerlibrary.xml b/reference/luasandbox/luasandbox/registerlibrary.xml
index aea52c6ce891..0e19cfbca64b 100644
--- a/reference/luasandbox/luasandbox/registerlibrary.xml
+++ b/reference/luasandbox/luasandbox/registerlibrary.xml
@@ -13,14 +13,14 @@
<methodparam><type>string</type><parameter>libname</parameter></methodparam>
<methodparam><type>array</type><parameter>functions</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Registers a set of PHP functions as a Lua library, so that Lua can call
the relevant PHP code.
- </para>
- <para>
+ </simpara>
+ <simpara>
For more information about calling Lua functions and the return values,
see <methodname>LuaSandboxFunction::call</methodname>.
- </para>
+ </simpara>
</refsect1>
@@ -30,20 +30,20 @@
<varlistentry>
<term><parameter>libname</parameter></term>
<listitem>
- <para>
+ <simpara>
The name of the library. In the Lua state, the global variable of this
name will be set to the table of functions. If the table already exists,
the new functions will be added to it.
- </para>
+ </simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>functions</parameter></term>
<listitem>
- <para>
+ <simpara>
An <type>array</type>, where each key is a function name, and each value is a
corresponding PHP <type>callable</type>.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -51,9 +51,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/luasandbox/luasandbox/setcpulimit.xml b/reference/luasandbox/luasandbox/setcpulimit.xml
index 3e7cc7b79ff9..cb8ff4e2cac2 100644
--- a/reference/luasandbox/luasandbox/setcpulimit.xml
+++ b/reference/luasandbox/luasandbox/setcpulimit.xml
@@ -12,27 +12,27 @@
<modifier>public</modifier> <type>void</type><methodname>LuaSandbox::setCPULimit</methodname>
<methodparam><type class="union"><type>float</type><type>bool</type></type><parameter>limit</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Sets the CPU time limit for the Lua environment.
- </para>
- <para>
+ </simpara>
+ <simpara>
If the total user and system time used by the environment after the call
to this method exceeds this limit, a <classname>LuaSandboxTimeoutError</classname>
exception is thrown.
- </para>
- <para>
+ </simpara>
+ <simpara>
Time used in PHP callbacks is included in the limit.
- </para>
- <para>
+ </simpara>
+ <simpara>
Setting the time limit from a callback while Lua is running causes the
timer to be reset, or started if it was not already running.
- </para>
+ </simpara>
<note>
- <para>
+ <simpara>
On Windows, the CPU limit will be ignored. On operating systems that do
not support <constant>CLOCK_THREAD_CPUTIME_ID</constant>, such as FreeBSD
and Mac OS X, wall-clock time rather than CPU time will be limited.
- </para>
+ </simpara>
</note>
</refsect1>
@@ -42,9 +42,9 @@
<varlistentry>
<term><parameter>limit</parameter></term>
<listitem>
- <para>
+ <simpara>
Limit as a <type>float</type> in seconds, or &false; for no limit.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -52,9 +52,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/luasandbox/luasandbox/setmemorylimit.xml b/reference/luasandbox/luasandbox/setmemorylimit.xml
index 8055109926eb..4a64f37847fd 100644
--- a/reference/luasandbox/luasandbox/setmemorylimit.xml
+++ b/reference/luasandbox/luasandbox/setmemorylimit.xml
@@ -12,13 +12,13 @@
<modifier>public</modifier> <type>void</type><methodname>LuaSandbox::setMemoryLimit</methodname>
<methodparam><type>int</type><parameter>limit</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Sets the memory limit for the Lua environment.
- </para>
- <para>
+ </simpara>
+ <simpara>
If this limit is exceeded, a <classname>LuaSandboxMemoryError</classname>
exception is thrown.
- </para>
+ </simpara>
</refsect1>
@@ -28,9 +28,9 @@
<varlistentry>
<term><parameter>limit</parameter></term>
<listitem>
- <para>
+ <simpara>
Memory limit in bytes.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -38,9 +38,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="examples">
diff --git a/reference/luasandbox/luasandbox/unpauseusagetimer.xml b/reference/luasandbox/luasandbox/unpauseusagetimer.xml
index 0b949da06642..37127b11d01e 100644
--- a/reference/luasandbox/luasandbox/unpauseusagetimer.xml
+++ b/reference/luasandbox/luasandbox/unpauseusagetimer.xml
@@ -12,9 +12,9 @@
<modifier>public</modifier> <type>void</type><methodname>LuaSandbox::unpauseUsageTimer</methodname>
<void/>
</methodsynopsis>
- <para>
+ <simpara>
Unpauses the timer paused by <methodname>LuaSandbox::pauseUsageTimer</methodname>.
- </para>
+ </simpara>
</refsect1>
@@ -25,9 +25,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
&return.void;
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
diff --git a/reference/luasandbox/luasandbox/wrapphpfunction.xml b/reference/luasandbox/luasandbox/wrapphpfunction.xml
index f59127d06bb2..079360c6840f 100644
--- a/reference/luasandbox/luasandbox/wrapphpfunction.xml
+++ b/reference/luasandbox/luasandbox/wrapphpfunction.xml
@@ -12,23 +12,23 @@
<modifier>public</modifier> <type>LuaSandboxFunction</type><methodname>LuaSandbox::wrapPhpFunction</methodname>
<methodparam><type>callable</type><parameter>function</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Wraps a PHP callable in a <classname>LuaSandboxFunction</classname>, so it
can be passed into Lua as an anonymous function.
- </para>
- <para>
+ </simpara>
+ <simpara>
The function must return either an array of values (which may be empty),
or &null; which is equivalent to returning the empty array.
- </para>
- <para>
+ </simpara>
+ <simpara>
Exceptions will be raised as errors in Lua, however only
<classname>LuaSandboxRuntimeError</classname> exceptions may be caught
inside Lua with <literal>pcall()</literal> or <literal>xpcall()</literal>.
- </para>
- <para>
+ </simpara>
+ <simpara>
For more information about calling Lua functions and the return values,
see <methodname>LuaSandboxFunction::call</methodname>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -37,9 +37,9 @@
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
- <para>
+ <simpara>
Callable to wrap.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -47,9 +47,9 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a <classname>LuaSandboxFunction</classname>.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="seealso">
diff --git a/reference/luasandbox/luasandboxerror.xml b/reference/luasandbox/luasandboxerror.xml
index d6de176b3d99..f653f279f0d6 100644
--- a/reference/luasandbox/luasandboxerror.xml
+++ b/reference/luasandbox/luasandboxerror.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.luasandboxerror" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.luasandboxerror" role="class">
<title>The LuaSandboxError class</title>
<titleabbrev>LuaSandboxError</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ LuaSandboxError intro -->
<section xml:id="luasandboxerror.intro">
&reftitle.intro;
- <para>
+ <simpara>
Base class for LuaSandbox exceptions
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -63,7 +62,7 @@
</fieldsynopsis>
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('exception.synopsis')/descendant::db:fieldsynopsis)" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('exception.synopsis')/descendant::db:fieldsynopsis)"/>
<!--
@@ -72,7 +71,7 @@
-->
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -87,28 +86,28 @@
<varlistentry xml:id="luasandboxerror.constants.run">
<term><constant>LuaSandboxError::RUN</constant></term>
<listitem>
- <para></para>
+ <simpara/>
</listitem>
</varlistentry>
<varlistentry xml:id="luasandboxerror.constants.syntax">
<term><constant>LuaSandboxError::SYNTAX</constant></term>
<listitem>
- <para></para>
+ <simpara/>
</listitem>
</varlistentry>
<varlistentry xml:id="luasandboxerror.constants.mem">
<term><constant>LuaSandboxError::MEM</constant></term>
<listitem>
- <para></para>
+ <simpara/>
</listitem>
</varlistentry>
<varlistentry xml:id="luasandboxerror.constants.err">
<term><constant>LuaSandboxError::ERR</constant></term>
<listitem>
- <para></para>
+ <simpara/>
</listitem>
</varlistentry>
@@ -122,7 +121,6 @@
<!-- &reference.luasandbox.entities.luasandboxerror; -->
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/luasandbox/luasandboxerrorerror.xml b/reference/luasandbox/luasandboxerrorerror.xml
index 1148a69fa6b9..95f7f5dbe6e7 100644
--- a/reference/luasandbox/luasandboxerrorerror.xml
+++ b/reference/luasandbox/luasandboxerrorerror.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.luasandboxerrorerror" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.luasandboxerrorerror" role="class">
<title>The LuaSandboxErrorError class</title>
<titleabbrev>LuaSandboxErrorError</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ LuaSandboxErrorError intro -->
<section xml:id="luasandboxerrorerror.intro">
&reftitle.intro;
- <para>
+ <simpara>
Exception thrown when Lua encounters an error inside an error handler.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -38,7 +37,7 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('exception.synopsis')/descendant::db:fieldsynopsis)" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('exception.synopsis')/descendant::db:fieldsynopsis)"/>
<!--
@@ -47,7 +46,7 @@
-->
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -59,7 +58,6 @@
<!-- &reference.luasandbox.entities.luasandboxerrorerror; -->
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/luasandbox/luasandboxfatalerror.xml b/reference/luasandbox/luasandboxfatalerror.xml
index 2d4b38d9cc15..ae9f253532c5 100644
--- a/reference/luasandbox/luasandboxfatalerror.xml
+++ b/reference/luasandbox/luasandboxfatalerror.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.luasandboxfatalerror" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.luasandboxfatalerror" role="class">
<title>The LuaSandboxFatalError class</title>
<titleabbrev>LuaSandboxFatalError</titleabbrev>
@@ -11,13 +10,13 @@
<!-- {{{ LuaSandboxFatalError intro -->
<section xml:id="luasandboxfatalerror.intro">
&reftitle.intro;
- <para>
+ <simpara>
Uncatchable LuaSandbox exceptions.
- </para>
- <para>
+ </simpara>
+ <simpara>
These may not be caught inside Lua using
<literal>pcall()</literal> or <literal>xpcall()</literal>.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -42,7 +41,7 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('exception.synopsis')/descendant::db:fieldsynopsis)" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('exception.synopsis')/descendant::db:fieldsynopsis)"/>
<!--
@@ -51,7 +50,7 @@
-->
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -63,7 +62,6 @@
<!-- &reference.luasandbox.entities.luasandboxfatalerror; -->
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/luasandbox/luasandboxfunction.xml b/reference/luasandbox/luasandboxfunction.xml
index 0d0e37b7b143..a967c4be5e93 100644
--- a/reference/luasandbox/luasandboxfunction.xml
+++ b/reference/luasandbox/luasandboxfunction.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.luasandboxfunction" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.luasandboxfunction" role="class">
<title>The LuaSandboxFunction class</title>
<titleabbrev>LuaSandboxFunction</titleabbrev>
@@ -11,16 +10,16 @@
<!-- {{{ LuaSandboxFunction intro -->
<section xml:id="luasandboxfunction.intro">
&reftitle.intro;
- <para>
+ <simpara>
Represents a Lua function, allowing it to be called from PHP.
- </para>
- <para>
+ </simpara>
+ <simpara>
A LuaSandboxFunction may be obtained as a return value from Lua, as a parameter
passed to a callback from Lua, or by using
<methodname>LuaSandbox::wrapPhpFunction</methodname>,
<methodname>LuaSandbox::loadString</methodname>, or
<methodname>LuaSandbox::loadBinary</methodname>.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -40,7 +39,7 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.luasandboxfunction')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.luasandboxfunction')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -51,7 +50,6 @@
&reference.luasandbox.entities.luasandboxfunction;
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/luasandbox/luasandboxfunction/call.xml b/reference/luasandbox/luasandboxfunction/call.xml
index 370ce34666e1..c0536015e9a5 100644
--- a/reference/luasandbox/luasandboxfunction/call.xml
+++ b/reference/luasandbox/luasandboxfunction/call.xml
@@ -12,102 +12,102 @@
<modifier>public</modifier> <type class="union"><type>array</type><type>bool</type></type><methodname>LuaSandboxFunction::call</methodname>
<methodparam rep="repeat"><type>string</type><parameter>args</parameter></methodparam>
</methodsynopsis>
- <para>
+ <simpara>
Calls a Lua function.
- </para>
- <para>
+ </simpara>
+ <simpara>
Errors considered to be the fault of the PHP code will result in the
function returning &false; and <constant>E_WARNING</constant>
being raised, for example, a <type>resource</type> type being used as an
argument. Lua errors will result in a <classname>LuaSandboxRuntimeError</classname>
exception being thrown.
- </para>
- <para>
+ </simpara>
+ <simpara>
PHP and Lua types are converted as follows:
- </para>
+ </simpara>
<itemizedlist>
<listitem>
- <para>PHP &null; is Lua <literal>nil</literal>, and vice versa.</para>
+ <simpara>PHP &null; is Lua <literal>nil</literal>, and vice versa.</simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
PHP <type>int</type>s and <type>float</type>s are converted to Lua
numbers. Infinity and <constant>NAN</constant> are supported.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
Lua numbers without a fractional part between approximately <literal>-2**53</literal>
and <literal>2**53</literal> are converted to PHP <type>int</type>s, with others
being converted to PHP <type>float</type>s.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>PHP <type>bool</type>s are Lua booleans, and vice versa.</para>
+ <simpara>PHP <type>bool</type>s are Lua booleans, and vice versa.</simpara>
</listitem>
<listitem>
- <para>PHP <type>string</type>s are Lua strings, and vice versa.</para>
+ <simpara>PHP <type>string</type>s are Lua strings, and vice versa.</simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
Lua functions are PHP <classname>LuaSandboxFunction</classname> objects, and vice versa.
General PHP <type>callable</type>s are not supported.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
PHP <type>array</type>s are converted to Lua tables, and vice versa.
- </para>
+ </simpara>
<itemizedlist>
<listitem>
- <para>
+ <simpara>
Note that Lua typically indexes arrays from 1, while PHP indexes
arrays from 0. No adjustment is made for these differing
conventions.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>Self-referential arrays are not supported in either direction.</para>
+ <simpara>Self-referential arrays are not supported in either direction.</simpara>
</listitem>
<listitem>
- <para>PHP references are dereferenced.</para>
+ <simpara>PHP references are dereferenced.</simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
Lua <literal>__pairs</literal> and <literal>__ipairs</literal> are processed.
<literal>__index</literal> is ignored.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
When converting from PHP to Lua, integer keys between
<literal>-2**53</literal> and <literal>2**53</literal> are represented
as Lua numbers. All other keys are represented as Lua strings.
- </para>
+ </simpara>
</listitem>
<listitem>
- <para>
+ <simpara>
When converting from Lua to PHP, keys other than strings and
numbers will result in an error, as will collisions when converting
numbers to strings or vice versa (since PHP considers things like
<literal>$a[0]</literal> and <literal>$a["0"]</literal> as being equivalent).
- </para>
+ </simpara>
</listitem>
</itemizedlist>
</listitem>
<listitem>
- <para>
+ <simpara>
All other types are unsupported and will raise an error/exception,
including general PHP <type>object</type>s and Lua userdata and thread types.
- </para>
+ </simpara>
</listitem>
</itemizedlist>
- <para>
+ <simpara>
Lua functions inherently return a list of results. So on success, this
method returns an <type>array</type> containing all of the values returned by Lua,
with <type>int</type> keys starting from zero. Lua may return no results, in
which case an empty array is returned.
- </para>
+ </simpara>
</refsect1>
<refsect1 role="parameters">
@@ -116,9 +116,9 @@
<varlistentry>
<term><parameter>args</parameter></term>
<listitem>
- <para>
+ <simpara>
Arguments passed to the function.
- </para>
+ </simpara>
</listitem>
</varlistentry>
</variablelist>
@@ -126,10 +126,10 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns an <type>array</type> of values returned by the function, which may be empty,
&return.falseforfailure;.
- </para>
+ </simpara>
</refsect1>
</refentry>
diff --git a/reference/luasandbox/luasandboxfunction/construct.xml b/reference/luasandbox/luasandboxfunction/construct.xml
index 8f18c08b7a12..ae94d0972b3b 100644
--- a/reference/luasandbox/luasandboxfunction/construct.xml
+++ b/reference/luasandbox/luasandboxfunction/construct.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="luasandboxfunction.construct" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="luasandboxfunction.construct">
<refnamediv>
<refname>LuaSandboxFunction::__construct</refname>
<refpurpose>Unused</refpurpose>
@@ -11,15 +10,15 @@
&reftitle.description;
<constructorsynopsis>
<modifier>final</modifier> <modifier>private</modifier> <methodname>LuaSandboxFunction::__construct</methodname>
- <void />
+ <void/>
</constructorsynopsis>
- <para>
+ <simpara>
<classname>LuaSandboxFunction</classname> are obtained as a return value from Lua,
as a parameter passed to a callback from Lua, or by using
<methodname>LuaSandbox::wrapPhpFunction</methodname>,
<methodname>LuaSandbox::loadString</methodname>, or
<methodname>LuaSandbox::loadBinary</methodname>. They cannot be constructed directly.
- </para>
+ </simpara>
</refsect1>
@@ -29,7 +28,6 @@
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/luasandbox/luasandboxfunction/dump.xml b/reference/luasandbox/luasandboxfunction/dump.xml
index d1342c595d41..4c76c59ee129 100644
--- a/reference/luasandbox/luasandboxfunction/dump.xml
+++ b/reference/luasandbox/luasandboxfunction/dump.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<refentry xml:id="luasandboxfunction.dump" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="luasandboxfunction.dump">
<refnamediv>
<refname>LuaSandboxFunction::dump</refname>
<refpurpose>Dump the function as a binary blob</refpurpose>
@@ -11,11 +10,11 @@
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>string</type><methodname>LuaSandboxFunction::dump</methodname>
- <void />
+ <void/>
</methodsynopsis>
- <para>
+ <simpara>
Dumps the function as a binary blob.
- </para>
+ </simpara>
</refsect1>
@@ -26,13 +25,12 @@
<refsect1 role="returnvalues">
&reftitle.returnvalues;
- <para>
+ <simpara>
Returns a string that may be passed to <methodname>LuaSandbox::loadBinary</methodname>.
- </para>
+ </simpara>
</refsect1>
</refentry>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/luasandbox/luasandboxmemoryerror.xml b/reference/luasandbox/luasandboxmemoryerror.xml
index 3f798f5d2e3a..9ae6439a924d 100644
--- a/reference/luasandbox/luasandboxmemoryerror.xml
+++ b/reference/luasandbox/luasandboxmemoryerror.xml
@@ -10,9 +10,9 @@
<!-- {{{ LuaSandboxMemoryError intro -->
<section xml:id="luasandboxmemoryerror.intro">
&reftitle.intro;
- <para>
+ <simpara>
Exception thrown when Lua cannot allocate memory.
- </para>
+ </simpara>
</section>
<!-- }}} -->
diff --git a/reference/luasandbox/luasandboxruntimeerror.xml b/reference/luasandbox/luasandboxruntimeerror.xml
index 74c26c621a64..68a40b2c1d2e 100644
--- a/reference/luasandbox/luasandboxruntimeerror.xml
+++ b/reference/luasandbox/luasandboxruntimeerror.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.luasandboxruntimeerror" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.luasandboxruntimeerror" role="class">
<title>The LuaSandboxRuntimeError class</title>
<titleabbrev>LuaSandboxRuntimeError</titleabbrev>
@@ -11,13 +10,13 @@
<!-- {{{ LuaSandboxRuntimeError intro -->
<section xml:id="luasandboxruntimeerror.intro">
&reftitle.intro;
- <para>
+ <simpara>
Catchable LuaSandbox runtime exceptions.
- </para>
- <para>
+ </simpara>
+ <simpara>
These may be caught inside Lua using
<literal>pcall()</literal> or <literal>xpcall()</literal>.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -42,7 +41,7 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('exception.synopsis')/descendant::db:fieldsynopsis)" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('exception.synopsis')/descendant::db:fieldsynopsis)"/>
<!--
@@ -51,7 +50,7 @@
-->
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -63,7 +62,6 @@
<!-- &reference.luasandbox.entities.luasandboxruntimeerror; -->
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/luasandbox/luasandboxsyntaxerror.xml b/reference/luasandbox/luasandboxsyntaxerror.xml
index c2e683934d60..75c2ae450954 100644
--- a/reference/luasandbox/luasandboxsyntaxerror.xml
+++ b/reference/luasandbox/luasandboxsyntaxerror.xml
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<reference xml:id="class.luasandboxsyntaxerror" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
+<reference xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude" xml:id="class.luasandboxsyntaxerror" role="class">
<title>The LuaSandboxSyntaxError class</title>
<titleabbrev>LuaSandboxSyntaxError</titleabbrev>
@@ -11,9 +10,9 @@
<!-- {{{ LuaSandboxSyntaxError intro -->
<section xml:id="luasandboxsyntaxerror.intro">
&reftitle.intro;
- <para>
+ <simpara>
Exception thrown when Lua code cannot be parsed.
- </para>
+ </simpara>
</section>
<!-- }}} -->
@@ -38,7 +37,7 @@
<!-- }}} -->
<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('exception.synopsis')/descendant::db:fieldsynopsis)" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('exception.synopsis')/descendant::db:fieldsynopsis)"/>
<!--
@@ -47,7 +46,7 @@
-->
<classsynopsisinfo role="comment">&InheritedMethods;</classsynopsisinfo>
- <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])" />
+ <xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.exception')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[not(@role='procedural')])"/>
</classsynopsis>
<!-- }}} -->
@@ -59,7 +58,6 @@
<!-- &reference.luasandbox.entities.luasandboxsyntaxerror; -->
</reference>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
diff --git a/reference/luasandbox/luasandboxtimeouterror.xml b/reference/luasandbox/luasandboxtimeouterror.xml
index 205a16a5e751..978f453b4ae9 100644
--- a/reference/luasandbox/luasandboxtimeouterror.xml
+++ b/reference/luasandbox/luasandboxtimeouterror.xml
@@ -10,9 +10,9 @@
<!-- {{{ LuaSandboxTimeoutError intro -->
<section xml:id="luasandboxtimeouterror.intro">
&reftitle.intro;
- <para>
+ <simpara>
Exception thrown when the configured CPU time limit is exceeded.
- </para>
+ </simpara>
</section>
<!-- }}} -->
diff --git a/reference/luasandbox/setup.xml b/reference/luasandbox/setup.xml
index 1e20f160f66f..6a1ad7e581e5 100644
--- a/reference/luasandbox/setup.xml
+++ b/reference/luasandbox/setup.xml
@@ -1,38 +1,37 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
-
-<chapter xml:id="luasandbox.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="luasandbox.setup">
&reftitle.setup;
<section xml:id="luasandbox.requirements">
&reftitle.required;
- <para>
+ <simpara>
To use this extension, Lua 5.1 will need to be installed, available on the <link xlink:href="&url.lua;">Lua homepage</link>.
- </para>
- <para>
+ </simpara>
+ <simpara>
To make full use of the timer features, LuaSandbox should be installed on
Linux.
- </para>
- <para>
+ </simpara>
+ <simpara>
If FreeBSD or Mac OS X is used, only real (wall-clock) time is
supported, the functions purporting to return CPU time will actually return
wall clock time.
- </para>
- <para>
+ </simpara>
+ <simpara>
If Windows is used, no timer functions will be supported. The time limits
will be inoperable.
- </para>
+ </simpara>
</section>
<section xml:id="luasandbox.installation">
&reftitle.install;
- <para>
+ <simpara>
&pecl.moved;
- </para>
- <para>
+ </simpara>
+ <simpara>
&pecl.info;
<link xlink:href="&url.pecl.package;luasandbox">&url.pecl.package;luasandbox</link>.
- </para>
+ </simpara>
<para>
If the operating system is Debian 10 or later, or Ubuntu 18.04 or later, then
LuaSandbox should typically be installed from the package
@@ -46,7 +45,6 @@ sudo apt-get install php-luasandbox
</section>
</chapter>
-
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml