2012-04-27 16:28:54 +00:00
V8Js
====
2013-04-15 20:57:43 +00:00
This is a PHP extension for Google's V8 Javascript engine.
The extension allows you to execute Javascript code in a secure sandbox from PHP. The executed code can be restricted using a time limit and/or memory limit. This provides the possibility to execute untrusted code with confidence.
2012-04-27 16:28:54 +00:00
Minimum requirements
--------------------
2013-04-15 20:57:43 +00:00
- V8 Javascript Engine library (libv8) version 3.2.4 or above < http: // code . google . com / p / v8 /> (trunk)
2012-04-27 16:47:52 +00:00
2013-04-15 20:57:43 +00:00
V8 is Google's open source Javascript engine.
2012-04-27 16:47:52 +00:00
V8 is written in C++ and is used in Google Chrome, the open source browser from Google.
2013-04-15 20:57:43 +00:00
V8 implements ECMAScript as specified in ECMA-262, 5th edition.
This extension makes use of V8 isolates to ensure separation between multiple V8Js instances, hence the need for 3.2.4 or above.
- PHP 5.3.3+
2012-04-27 16:28:54 +00:00
2013-04-15 20:57:43 +00:00
This embedded implementation of the V8 engine uses thread locking so it should work with ZTS enabled.
However, this has not been tested yet.
2012-04-27 16:28:54 +00:00
2013-04-15 20:57:43 +00:00
PHP API
=======
2012-04-27 16:28:54 +00:00
2012-07-24 12:03:32 +00:00
class V8Js
{
/* Constants */
const string V8_VERSION;
const int FLAG_NONE;
const int FLAG_FORCE_ARRAY;
/* Methods */
// Initializes and starts V8 engine and Returns new V8Js object with it's own V8 context.
2013-04-15 20:57:43 +00:00
public __construct ( [ string $object_name = "PHP" [, array $variables = NULL [, array $extensions = NULL [, bool $report_uncaught_exceptions = TRUE ] ] ] )
// Provide a function or method to be used to load required modules. This can be any valid PHP callable.
// The loader function will receive the normalised module path and should return Javascript code to be executed.
public setModuleLoader ( callable $loader )
2012-07-24 12:03:32 +00:00
// Compiles and executes script in object's context with optional identifier string.
2013-04-15 20:57:43 +00:00
// A time limit (milliseconds) and/or memory limit (bytes) can be provided to restrict execution. These options will throw a V8JsTimeLimitException or V8JsMemoryLimitException.
public mixed V8Js::executeString( string $script [, string $identifier [, int $flags = V8Js::FLAG_NONE [, int $time_limit = 0 [, int $memory_limit = 0]]]])
2012-07-24 12:03:32 +00:00
// Returns uncaught pending exception or null if there is no pending exception.
2013-04-15 20:57:43 +00:00
public V8JsScriptException V8Js::getPendingException( )
2012-07-24 12:03:32 +00:00
/** Static methods ** /
// Registers persistent context independent global Javascript extension.
// NOTE! These extensions exist until PHP is shutdown and they need to be registered before V8 is initialized.
// For best performance V8 is initialized only once per process thus this call has to be done before any V8Js objects are created!
2013-04-15 20:57:43 +00:00
public static bool V8Js::registerExtension( string $extension_name, string $code [, array $dependenciess [, bool $auto_enable = FALSE ] ] )
2012-07-24 12:03:32 +00:00
// Returns extensions successfully registered with V8Js::registerExtension().
2013-04-15 20:57:43 +00:00
public static array V8Js::getExtensions( )
2012-07-24 12:03:32 +00:00
}
2013-04-13 23:36:31 +00:00
final class V8JsScriptException extends Exception
2012-07-24 12:03:32 +00:00
{
/* Properties */
protected string JsFileName = NULL;
protected int JsLineNumber = NULL;
protected string JsSourceLine = NULL;
protected string JsTrace = NULL;
/* Methods */
2013-04-15 20:57:43 +00:00
final public string getJsFileName( )
final public int getJsLineNumber( )
final public string getJsSourceLine( )
final public string getJsTrace( )
2012-07-24 12:03:32 +00:00
}
2013-04-15 20:57:43 +00:00
final class V8JsTimeLimitException extends Exception
{
}
final class V8JsMemoryLimitException extends Exception
{
}
Javascript API
==============
// Print a string.
print(string);
// Dump the contents of a variable.
var_dump(value);
// Terminate Javascript execution immediately.
exit();
// CommonJS Module support to require external code.
// This makes use of the PHP module loader provided via V8Js::setModuleLoader (see PHP API above).
require("path/to/module");
2012-07-24 12:03:32 +00:00