wrapphpfunction.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 990521c9ca64fe7d83016a613b850177d3a90776 Maintainer: sergey Status: ready -->
<!-- Reviewed: no -->
<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>Оборачивает вызываемый PHP-объект в <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>
   Оборачивает вызываемый PHP-объект в <classname>LuaSandboxFunction</classname>,
   поэтому его можно передать в Lua как анонимную функцию.
  </para>
  <para>
   Функция должна возвращать либо массив значений (который может быть пустым),
   либо &null;, что эквивалентно возврату пустого массива.
  </para>
  <para>
   Исключения будут возникать как ошибки в Lua, однако только исключения
   <classname>LuaSandboxRuntimeError</classname> могут быть обработаны внутри Lua
   с помощью <literal>pcall()</literal> или <literal>xpcall()</literal>.
  </para>
  <para>
   Для получения дополнительной информации о вызове функций Lua и возвращаемых значениях
   смотрите <methodname>LuaSandboxFunction::call</methodname>.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>function</parameter></term>
    <listitem>
     <para>
      Вызываемая функция для обёртывания.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Возвращает <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
-->