mirror of
https://github.com/phpv8/v8js.git
synced 2024-11-10 03:48:42 +00:00
100 lines
3.8 KiB
Markdown
100 lines
3.8 KiB
Markdown
V8Js
|
|
====
|
|
|
|
This is a PHP extension for Google's V8 Javascript engine.
|
|
|
|
This 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.
|
|
|
|
|
|
Minimum requirements
|
|
--------------------
|
|
|
|
- V8 Javascript Engine library (libv8) version 3.2.4 or above <http://code.google.com/p/v8/> (trunk)
|
|
|
|
V8 is Google's open source Javascript engine.
|
|
V8 is written in C++ and is used in Google Chrome, the open source browser from Google.
|
|
V8 implements ECMAScript as specified in ECMA-262, 5th edition.
|
|
This extensions 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+
|
|
Note: This embedded implementation of the V8 engine uses thread locking so it should work with ZTS enabled. However, this has not been tested yet.
|
|
|
|
|
|
PHP API
|
|
=======
|
|
|
|
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.
|
|
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 )
|
|
|
|
// Compiles and executes script in object's context with optional identifier string.
|
|
// 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]]]])
|
|
|
|
// Returns uncaught pending exception or null if there is no pending exception.
|
|
public V8JsScriptException V8Js::getPendingException( )
|
|
|
|
/** 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!
|
|
public static bool V8Js::registerExtension( string $extension_name, string $code [, array $dependenciess [, bool $auto_enable = FALSE ] ] )
|
|
|
|
// Returns extensions successfully registered with V8Js::registerExtension().
|
|
public static array V8Js::getExtensions( )
|
|
}
|
|
|
|
final class V8JsScriptException extends Exception
|
|
{
|
|
/* Properties */
|
|
protected string JsFileName = NULL;
|
|
protected int JsLineNumber = NULL;
|
|
protected string JsSourceLine = NULL;
|
|
protected string JsTrace = NULL;
|
|
|
|
/* Methods */
|
|
final public string getJsFileName( )
|
|
final public int getJsLineNumber( )
|
|
final public string getJsSourceLine( )
|
|
final public string getJsTrace( )
|
|
}
|
|
|
|
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();
|
|
|
|
// Require external module code
|
|
// This method will make use of the module loader provided via V8Js::setModuleLoader (see above).
|
|
require("path/to/module");
|
|
|