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

LuaSandbox {
/* Constants */
const integer SAMPLES = 0 ;
const integer SECONDS = 1 ;
const integer PERCENT = 2 ;
/* Methods */
public callFunction ( string $name [, mixed $... ] ) : array|bool
public disableProfiler ( void ) : void
public enableProfiler ([ float $period = 0.02 ] ) : bool
public getCPUUsage ( void ) : float
public getMemoryUsage ( void ) : int
public getPeakMemoryUsage ( void ) : int
public getProfilerFunctionReport ([ int $units = LuaSandbox::SECONDS ] ) : array
public static getVersionInfo ( void ) : array
public loadBinary ( string $code [, string $chunkName = '' ] ) : LuaSandboxFunction
public loadString ( string $code [, string $chunkName = '' ] ) : LuaSandboxFunction
public pauseUsageTimer ( void ) : bool
public registerLibrary ( string $libname , array $functions ) : void
public setCPULimit ( float|bool $limit ) : void
public setMemoryLimit ( int $limit ) : void
public unpauseUsageTimer ( void ) : 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