<!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>Compile a string of PHP code and return the resulting op array</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.parsekit.html">Parsekit Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.parsekit-compile-string.html">parsekit_compile_string</a></div>
<div class="up"><a href="ref.parsekit.html">Parsekit Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.parsekit-compile-file" class="refentry">
<div class="refnamediv">
<h1 class="refname">parsekit_compile_file</h1>
<p class="verinfo">(PECL parsekit >= 0.2.0)</p><p class="refpurpose"><span class="refname">parsekit_compile_file</span> — <span class="dc-title">Compile a string of PHP code and return the resulting op array</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.parsekit-compile-file-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>parsekit_compile_file</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$errors</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$options</code><span class="initializer"> = PARSEKIT_QUIET</span></span>
]] )</div>
<div class="warning"><strong class="warning">Warning</strong><p class="simpara">This function is
<em class="emphasis">EXPERIMENTAL</em>. The behaviour of this function, its name, and
surrounding documentation may change without notice in a future release of PHP.
This function should be used at your own risk.
</p></div>
</div>
<div class="refsect1 parameters" id="refsect1-function.parsekit-compile-file-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">filename</code></em></span>
<dd>
<p class="para">
A string containing the name of the file to compile.
Similar to the argument to <span class="function"><a href="function.include.html" class="function">include</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">errors</code></em></span>
<dd>
<p class="para">
A 2D hash of errors (including fatal errors) encountered during compilation.
Returned by reference.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">options</code></em></span>
<dd>
<p class="para">
One of either <strong><code>PARSEKIT_QUIET</code></strong> or
<strong><code>PARSEKIT_SIMPLE</code></strong>. To produce varying
degrees of verbosity in the returned output.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.parsekit-compile-file-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns a complex multi-layer array structure as detailed below.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.parsekit-compile-file-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-3793">
<p><strong>Example #1 <span class="function"><strong>parsekit_compile_file()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">parsekit_compile_file</span><span style="color: #007700">(</span><span style="color: #DD0000">'hello_world.php'</span><span style="color: #007700">, </span><span style="color: #0000BB">$errors</span><span style="color: #007700">, </span><span style="color: #0000BB">PARSEKIT_SIMPLE</span><span style="color: #007700">));<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(5) {
[0]=>
string(37) "ZEND_ECHO UNUSED 'Hello World' UNUSED"
[1]=>
string(30) "ZEND_RETURN UNUSED NULL UNUSED"
[2]=>
string(42) "ZEND_HANDLE_EXCEPTION UNUSED UNUSED UNUSED"
["function_table"]=>
NULL
["class_table"]=>
NULL
}
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.parsekit-compile-file-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.parsekit-compile-string.html" class="function" rel="rdfs-seeAlso">parsekit_compile_string()</a> - Compile a string of PHP code and return the resulting op array</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.parsekit.html">Parsekit Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.parsekit-compile-string.html">parsekit_compile_string</a></div>
<div class="up"><a href="ref.parsekit.html">Parsekit Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
