php-doc-en/reference/luasandbox/luasandbox.xml
Tim Starling 990521c9ca Add LuaSandbox extension
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@347858 c90b9560-bf6c-de11-be94-00142212c4b1
2019-08-16 01:38:57 +00:00

124 lines
3.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<phpdoc:classref xml:id="class.luasandbox" xmlns:phpdoc="http://php.net/ns/phpdoc" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The LuaSandbox class</title>
<titleabbrev>LuaSandbox</titleabbrev>
<partintro>
<!-- {{{ LuaSandbox intro -->
<section xml:id="luasandbox.intro">
&reftitle.intro;
<para>
The LuaSandbox class creates a Lua environment and allows for execution of
Lua code.
</para>
</section>
<!-- }}} -->
<section xml:id="luasandbox.synopsis">
&reftitle.classsynopsis;
<!-- {{{ Synopsis -->
<classsynopsis>
<ooclass><classname>LuaSandbox</classname></ooclass>
<!-- {{{ Class synopsis -->
<classsynopsisinfo>
<ooclass>
<classname>LuaSandbox</classname>
</ooclass>
</classsynopsisinfo>
<!-- }}} -->
<classsynopsisinfo role="comment">Constants</classsynopsisinfo>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="luasandbox.constants.samples">LuaSandbox::SAMPLES</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="luasandbox.constants.seconds">LuaSandbox::SECONDS</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>const</modifier>
<type>integer</type>
<varname linkend="luasandbox.constants.percent">LuaSandbox::PERCENT</varname>
<initializer>2</initializer>
</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')])" />
</classsynopsis>
<!-- }}} -->
</section>
<!-- {{{ LuaSandbox constants -->
<section xml:id="luasandbox.constants">
&reftitle.constants;
<variablelist>
<varlistentry xml:id="luasandbox.constants.samples">
<term><constant>LuaSandbox::SAMPLES</constant></term>
<listitem>
<para>
Used with <methodname>LuaSandbox::getProfilerFunctionReport</methodname> to return timings in samples.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="luasandbox.constants.seconds">
<term><constant>LuaSandbox::SECONDS</constant></term>
<listitem>
<para>
Used with <methodname>LuaSandbox::getProfilerFunctionReport</methodname> to return timings in seconds.
</para>
</listitem>
</varlistentry>
<varlistentry xml:id="luasandbox.constants.percent">
<term><constant>LuaSandbox::PERCENT</constant></term>
<listitem>
<para>
Used with <methodname>LuaSandbox::getProfilerFunctionReport</methodname> to return timings in percentages of the total.
</para>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- }}} -->
</partintro>
&reference.luasandbox.entities.luasandbox;
</phpdoc:classref>
<!-- 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
-->