The LuaSandbox class

Introduction

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

LuaSandbox

class LuaSandbox {

/* Constants */

const int LuaSandbox::SAMPLES = 0;

const int LuaSandbox::SECONDS = 1;

const int LuaSandbox::PERCENT = 2;

/* Methods */

public arraybool callFunction(string $name, mixed ...$args)

public void disableProfiler()

public bool enableProfiler(float $period = 0.02)

public float getCPUUsage()

public int getMemoryUsage()

public int getPeakMemoryUsage()

public array getProfilerFunctionReport(int $units = LuaSandbox::SECONDS)

public static array getVersionInfo()

public LuaSandboxFunction loadBinary(string $code, string $chunkName = '')

public LuaSandboxFunction loadString(string $code, string $chunkName = '')

public bool pauseUsageTimer()

public void registerLibrary(string $libname, array $functions)

public void setCPULimit(floatbool $limit)

public void setMemoryLimit(int $limit)

public void unpauseUsageTimer()

public LuaSandboxFunction wrapPhpFunction(callable $function)

}

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

LuaSandbox::callFunction — Call a function in a Lua global variable
LuaSandbox::disableProfiler — Disable the profiler
LuaSandbox::enableProfiler — Enable the profiler.
LuaSandbox::getCPUUsage — Fetch the current CPU time usage of the Lua environment
LuaSandbox::getMemoryUsage — Fetch the current memory usage of the Lua environment
LuaSandbox::getPeakMemoryUsage — Fetch the peak memory usage of the Lua environment
LuaSandbox::getProfilerFunctionReport — Fetch profiler data
LuaSandbox::getVersionInfo — Return the versions of LuaSandbox and Lua
LuaSandbox::loadBinary — Load a precompiled binary chunk into the Lua environment
LuaSandbox::loadString — Load Lua code into the Lua environment
LuaSandbox::pauseUsageTimer — Pause the CPU usage timer
LuaSandbox::registerLibrary — Register a set of PHP functions as a Lua library
LuaSandbox::setCPULimit — Set the CPU time limit for the Lua environment
LuaSandbox::setMemoryLimit — Set the memory limit for the Lua environment
LuaSandbox::unpauseUsageTimer — Unpause the timer paused by LuaSandbox::pauseUsageTimer
LuaSandbox::wrapPhpFunction — Wrap a PHP callable in a LuaSandboxFunction