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

    classLuaSandbox {
    constintSAMPLES = 0;
    constintSECONDS = 1;
    constintPERCENT = 2;
    publiccallFunction(string$name, mixed...$args): array|bool
    publicdisableProfiler(): void
    publicenableProfiler(float$period = 0.02): bool
    publicgetCPUUsage(): float
    publicgetMemoryUsage(): int
    publicgetPeakMemoryUsage(): int
    publicgetProfilerFunctionReport(int$units = LuaSandbox::SECONDS): array
    publicstaticgetVersionInfo(): array
    publicloadBinary(string$code, string$chunkName = ''): LuaSandboxFunction
    publicloadString(string$code, string$chunkName = ''): LuaSandboxFunction
    publicpauseUsageTimer(): bool
    publicregisterLibrary(string$libname, array$functions): void
    publicsetCPULimit(float|bool$limit): void
    publicsetMemoryLimit(int$limit): void
    publicunpauseUsageTimer(): void
    publicwrapPhpFunction(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

    To Top