<!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>Assign a PHP variable to Lua</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.lua.html">Lua</a></div>
<div class="next" style="text-align: right; float: right;"><a href="lua.call.html">Lua::call</a></div>
<div class="up"><a href="class.lua.html">Lua</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="lua.assign" class="refentry">
<div class="refnamediv">
<h1 class="refname">Lua::assign</h1>
<p class="verinfo">(PECL lua >=0.9.0)</p><p class="refpurpose"><span class="refname">Lua::assign</span> — <span class="dc-title">Assign a PHP variable to Lua</span></p>
</div>
<div class="refsect1 description" id="refsect1-lua.assign-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="modifier">public</span> <span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>Lua::assign</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$name</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span>
)</div>
<p class="para rdfs-comment">
</p>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
currently not documented; only its argument list is available.
</p></div>
</div>
<div class="refsect1 parameters" id="refsect1-lua.assign-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">name</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">value</code></em></span>
<dd>
<p class="para">
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-lua.assign-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <var class="varname"><var class="varname">$this</var></var> or <strong><code>NULL</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-lua.assign-examples">
<h3 class="title">Examples</h3>
<div class="example" id="example-3766">
<p><strong>Example #1 <span class="function"><strong>Lua::assign()</strong></span>example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$lua </span><span style="color: #007700">= new </span><span style="color: #0000BB">Lua</span><span style="color: #007700">();<br /></span><span style="color: #0000BB">$lua</span><span style="color: #007700">-></span><span style="color: #0000BB">assign</span><span style="color: #007700">(</span><span style="color: #DD0000">"php_var"</span><span style="color: #007700">, array(</span><span style="color: #0000BB">1</span><span style="color: #007700">=></span><span style="color: #0000BB">1</span><span style="color: #007700">, </span><span style="color: #0000BB">2</span><span style="color: #007700">, </span><span style="color: #0000BB">3</span><span style="color: #007700">)); </span><span style="color: #FF8000">//lua table index begin with 1<br /></span><span style="color: #0000BB">$lua</span><span style="color: #007700">-></span><span style="color: #0000BB">eval</span><span style="color: #007700">(<<<CODE<br /></span><span style="color: #DD0000"> print(php_var);<br /></span><span style="color: #007700">CODE<br />);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
Array
(
[1] => 1
[2] => 2
[3] => 3
)
</pre></div>
</div>
</div>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="class.lua.html">Lua</a></div>
<div class="next" style="text-align: right; float: right;"><a href="lua.call.html">Lua::call</a></div>
<div class="up"><a href="class.lua.html">Lua</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
