<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Register Javascript extensions for V8Js</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="v8js.getpendingexception.html">V8Js::getPendingException</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.v8jsexception.html">V8JsException</a></div>
<div class="up"><a href="class.v8js.html">V8Js</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="v8js.registerextension" class="refentry">
<div class="refnamediv">
<h1 class="refname">V8Js::registerExtension</h1>
<p class="verinfo">(PECL v8js >= 0.1.0)</p><p class="refpurpose"><span class="refname">V8Js::registerExtension</span> — <span class="dc-title">Register Javascript extensions for V8Js</span></p>
</div>
<div class="refsect1 description" id="refsect1-v8js.registerextension-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="modifier">static</span> <span class="type">bool</span> <span class="methodname"><strong>V8Js::registerExtension</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$extension_name</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$script</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$dependencies</code><span class="initializer"> = array()</span></span>
[, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$auto_enable</code><span class="initializer"> = <strong><code>FALSE</code></strong></span></span>
]] )</div>
<p class="para rdfs-comment">
Registers passed Javascript <em><code class="parameter">script</code></em> as extension to
be used in <a href="class.v8js.html" class="classname">V8Js</a> contexts.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-v8js.registerextension-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">extension_name</code></em></span>
<dd>
<p class="para">
Name of the extension to be registered.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">script</code></em></span>
<dd>
<p class="para">
The Javascript code to be registered.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">dependencies</code></em></span>
<dd>
<p class="para">
Array of extension names the extension to be registered depends on. Any such extension is
enabled automatically when this extension is loaded.
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
All extensions, including the dependencies, must be registered before any <a href="class.v8js.html" class="classname">V8Js</a>
are created which use them.
</p>
</p></blockquote>
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">auto_enable</code></em></span>
<dd>
<p class="para">
If set to <strong><code>TRUE</code></strong>, the extension will be enabled automatically in all <a href="class.v8js.html" class="classname">V8Js</a> contexts.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-v8js.registerextension-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> if extension was registered successfully, <strong><code>FALSE</code></strong> otherwise.
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="v8js.getpendingexception.html">V8Js::getPendingException</a></div>
<div class="next" style="text-align: right; float: right;"><a href="class.v8jsexception.html">V8JsException</a></div>
<div class="up"><a href="class.v8js.html">V8Js</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
