LuaSandbox::callFunction

    (PECL luasandbox >= 1.0.0)

    LuaSandbox::callFunction — Call a function in a Lua global variable

    Description

    public LuaSandbox::callFunction(string $name, mixed ...$args): array|bool

    Calls a function in a Lua global variable.

    If the name contains "." characters, the function is located via recursive table accesses, as if the name were a Lua expression.

    If the variable does not exist, or is not a function, false will be returned and a warning issued.

    For more information about calling Lua functions and the return values, see LuaSandboxFunction::call().

    Parameters

    name

    Lua variable name.

    args

    Arguments to the function.

    Return Values

    Returns an array of values returned by the Lua function, which may be empty, or false on failure.

    Examples

    Example #1 Calling a Lua function

    <?php

    // create a new LuaSandbox
    $sandbox = new LuaSandbox();

    // Call Lua's string.match
    $captures = $sandbox->callFunction( 'string.match', $string, $pattern );

    ?>

    Improve This Page

    Learn How To Improve This Page • Submit a Pull Request • Report a Bug
    ＋add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top