PHP 8.4.2 Released!

LuaSandbox::callFunction »

« Basic usage for LuaSandbox

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

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

Found A Problem?

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

User Contributed Notes

There are no user contributed notes for this page.