docs for bcompiler_write_file() function

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@175273 c90b9560-bf6c-de11-be94-00142212c4b1

reference/bcompiler/functions/bcompiler-write-file.xml

@@ -0,0 +1,65 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.1 $ -->
+  <refentry id="function.bcompiler-write-file">
+   <refnamediv>
+    <refname>bcompile_write_file</refname>
+    <refpurpose>Writes a php source file as bytecodes</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+     <methodsynopsis>
+      <type>bool</type><methodname>bcompiler_write_file</methodname>
+      <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam>
+      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
+     </methodsynopsis>
+   &warn.experimental.func;
+    <para>
+     This function complies specified source file into bytecodes, and writes 
+     them to the open file handle.
+    </para>
+    <example>
+     <title><function>bcompiler_write_file</function> example</title>
+     <programlisting role="php">
+<![CDATA[
+<?php
+$fh = fopen("example.phb", "w");
+bcompile_write_header($fh);
+bcompile_write_file($fh, "example.php");
+bcompile_write_footer($fh);
+fclose($fh);
+/* the following should be equivalent:
+include "example.php";
+   and
+include "example.phb";
+*/
+?>
+]]>
+     </programlisting>
+    </example>
+    <para>
+     See also <function>bcompiler_write_header</function>, and
+     <function>bcompiler_write_footer</function>.
+    </para>
+   </refsect1>
+  </refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:1
+sgml-indent-data:t
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->