The LuaSandbox class

    (PECL luasandbox >= 1.0.0)

    Introduction

    The LuaSandbox class creates a Lua environment and allows for execution of Lua code.

    Class synopsis

    class LuaSandbox {
    /* Constants */
    const int SAMPLES = 0;
    const int SECONDS = 1;
    const int PERCENT = 2;
    /* Methods */
    public callFunction(string $name, mixed ...$args): array|bool
    public disableProfiler(): void
    public enableProfiler(float $period = 0.02): bool
    public getCPUUsage(): float
    public getMemoryUsage(): int
    public getPeakMemoryUsage(): int
    public getProfilerFunctionReport(int $units = LuaSandbox::SECONDS): array
    public static getVersionInfo(): array
    public loadBinary(string $code, string $chunkName = ''): LuaSandboxFunction
    public loadString(string $code, string $chunkName = ''): LuaSandboxFunction
    public pauseUsageTimer(): bool
    public registerLibrary(string $libname, array $functions): void
    public setCPULimit(float|bool $limit): void
    public setMemoryLimit(int $limit): void
    public unpauseUsageTimer(): void
    public wrapPhpFunction(callable $function): LuaSandboxFunction
    }

    Predefined Constants

    LuaSandbox::SAMPLES

    Used with LuaSandbox::getProfilerFunctionReport() to return timings in samples.

    LuaSandbox::SECONDS

    Used with LuaSandbox::getProfilerFunctionReport() to return timings in seconds.

    LuaSandbox::PERCENT

    Used with LuaSandbox::getProfilerFunctionReport() to return timings in percentages of the total.

    Table of Contents

    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