1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="luasandbox.wrapphpfunction" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>LuaSandbox::wrapPhpFunction</refname>
<refpurpose>Wrap a PHP callable in a <classname>LuaSandboxFunction</classname></refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>LuaSandboxFunction</type><methodname>LuaSandbox::wrapPhpFunction</methodname>
<methodparam><type>callable</type><parameter>function</parameter></methodparam>
</methodsynopsis>
<para>
Wraps a PHP callable in a <classname>LuaSandboxFunction</classname>, so it
can be passed into Lua as an anonymous function.
</para>
<para>
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>
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>
For more information about calling Lua functions and the return values,
see <methodname>LuaSandboxFunction::call</methodname>.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>function</parameter></term>
<listitem>
<para>
Callable to wrap.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns a <classname>LuaSandboxFunction</classname>.
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><methodname>LuaSandbox::loadString</methodname></member>
<member><methodname>LuaSandbox::registerLibrary</methodname></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
-->
|
