<!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>Writes a php source file as bytecodes</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.bcompiler-write-exe-footer.html">bcompiler_write_exe_footer</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bcompiler-write-footer.html">bcompiler_write_footer</a></div>
<div class="up"><a href="ref.bcompiler.html">bcompiler Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.bcompiler-write-file" class="refentry">
<div class="refnamediv">
<h1 class="refname">bcompiler_write_file</h1>
<p class="verinfo">(PECL bcompiler >= 0.6)</p><p class="refpurpose"><span class="refname">bcompiler_write_file</span> — <span class="dc-title">Writes a php source file as bytecodes</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.bcompiler-write-file-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>bcompiler_write_file</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$filehandle</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
)</div>
<p class="para rdfs-comment">
This function complies specified source file into bytecodes, and writes
them to the open file handle.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.bcompiler-write-file-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">filehandle</code></em></span>
<dd>
<p class="para">
A file handle as returned by <span class="function"><a href="function.fopen.html" class="function">fopen()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">filename</code></em></span>
<dd>
<p class="para">
The source file path, as a string.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.bcompiler-write-file-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.bcompiler-write-file-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-442">
<p><strong>Example #1 <span class="function"><strong>bcompiler_write_file()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$fh </span><span style="color: #007700">= </span><span style="color: #0000BB">fopen</span><span style="color: #007700">(</span><span style="color: #DD0000">"example.phb"</span><span style="color: #007700">, </span><span style="color: #DD0000">"w"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">bcompiler_write_header</span><span style="color: #007700">(</span><span style="color: #0000BB">$fh</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">bcompiler_write_file</span><span style="color: #007700">(</span><span style="color: #0000BB">$fh</span><span style="color: #007700">, </span><span style="color: #DD0000">"example.php"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">bcompiler_write_footer</span><span style="color: #007700">(</span><span style="color: #0000BB">$fh</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">fclose</span><span style="color: #007700">(</span><span style="color: #0000BB">$fh</span><span style="color: #007700">);<br /></span><span style="color: #FF8000">/* the following should be equivalent:<br />include "example.php";<br /> and<br />include "example.phb";<br />*/<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.bcompiler-write-file-notes">
<h3 class="title">Notes</h3>
<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 seealso" id="refsect1-function.bcompiler-write-file-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.bcompiler-write-header.html" class="function" rel="rdfs-seeAlso">bcompiler_write_header()</a> - Writes the bcompiler header</span></li>
<li class="member"> <span class="function"><a href="function.bcompiler-write-footer.html" class="function" rel="rdfs-seeAlso">bcompiler_write_footer()</a> - Writes the single character \x00 to indicate End of compiled data</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="function.bcompiler-write-exe-footer.html">bcompiler_write_exe_footer</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.bcompiler-write-footer.html">bcompiler_write_footer</a></div>
<div class="up"><a href="ref.bcompiler.html">bcompiler Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
