1
0
mirror of https://github.com/php/doc-en.git synced 2026-03-24 07:42:10 +01:00
Files
archived-doc-en/reference/lua/lua/call.xml
2012-03-12 05:55:59 +00:00

131 lines
3.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="lua.call" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>Lua::call</refname>
<refname>Lua::__call</refname>
<refpurpose>Call Lua functions</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>Lua::call</methodname>
<methodparam><type>callable</type><parameter>lua_func</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>args</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>use_self</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<methodsynopsis>
<modifier>public</modifier> <type>mixed</type><methodname>Lua::__call</methodname>
<methodparam><type>callable</type><parameter>lua_func</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>args</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>use_self</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
</para>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>lua_func</parameter></term>
<listitem>
<para>
Function name in lua
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>args</parameter></term>
<listitem>
<para>
Arguments passed to the Lua function
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>use_self</parameter></term>
<listitem>
<para>
Whether to use <literal>self</literal>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns result of the called function, &null; for wrong arguments or
&false; on other failure.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>Lua::call</function>example</title>
<programlisting role="php">
<![CDATA[
<?php
$lua = new Lua();
$lua->eval(<<<CODE
function dummy(foo, bar)
print(foo, ",", bar)
end
CODE
);
$lua->call("dummy", array("Lua", "geiliable\n"));
$lua->dummy("Lua", "geiliable"); // __call()
var_dump($lua->call(array("table", "concat"), array(array(1=>1, 2=>2, 3=>3), "-")));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Lua,geiliable
Lua,geiliable
string(5) "1-2-3"
]]>
</screen>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><link linkend="object.call">__call()</link></member>
</simplelist>
</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
-->