cvs: phpdoc /en/reference/bcompiler/functions bcompiler-load-exe.xml bcompiler-load.xml bcompiler-parse-class.xml bcompiler-read.xml
bcompiler-write-class.xml bcompiler-write-constant.xml bcompiler-write-exe-footer.xml bcompiler-write-file.xml bcompiler-write-footer.xml
bcompiler-write-function.xml bcompiler-write-functions-from-file.xml bcompiler-write-header.xml
| From: | Mehdi Achour | Date: | Sat, 17 Feb 2007 18:44:52 +0000 |
| Subject: | cvs: phpdoc /en/reference/bcompiler/functions bcompiler-load-exe.xml bcompiler-load.xml bcompiler-parse-class.xml bcompiler-read.xml bcompiler-write-class.xml bcompiler-write-constant.xml bcompiler-write-exe-footer.xml bcompiler-write-file.xml bcompiler-write-footer.xml bcompiler-write-function.xml bcompiler-write-functions-from-file.xml bcompiler-write-header.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969375501@lists.php.net to get a copy of this message | ||
didou Sat Feb 17 18:44:52 2007 UTC
Modified files:
/phpdoc/en/reference/bcompiler/functions bcompiler-load-exe.xml
bcompiler-load.xml
bcompiler-parse-class.xml
bcompiler-read.xml
bcompiler-write-class.xml
bcompiler-write-constant.xml
bcompiler-write-exe-footer.xml
bcompiler-write-file.xml
bcompiler-write-footer.xml
bcompiler-write-function.xml
bcompiler-write-functions-from-file.xml
bcompiler-write-header.xml
Log:
WS: prepare for new doc style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml:1.3 Wed Apr 20 13:53:31 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml Sat Feb 17 18:44:52 2007 @@ -1,24 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-load-exe"> - <refnamediv> - <refname>bcompiler_load_exe</refname> - <refpurpose>Reads and creates classes from a bcompiler exe file</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_load_exe</methodname> - <methodparam><type>string</type><parameter>filename</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - Reads data from a bcompiler exe file and creates classes from the bytecodes. - </para> - <example> - <title><function>bcompiler_load</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-load-exe"> + <refnamediv> + <refname>bcompiler_load_exe</refname> + <refpurpose>Reads and creates classes from a bcompiler exe file</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_load_exe</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + Reads data from a bcompiler exe file and creates classes from the bytecodes. + </para> + <para> + <example> + <title><function>bcompiler_load</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -27,10 +28,11 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml:1.3 Sun Jan 2 16:06:53 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml Sat Feb 17 18:44:52 2007 @@ -1,31 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-load"> - <refnamediv> - <refname>bcompiler_load</refname> - <refpurpose>Reads and creates classes from a bz compressed file</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_load</methodname> - <methodparam><type>string</type><parameter>filename</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <note> - <para> - Please use include or require statements to parse bytecodes, it's more - portable and convenient way than using this function. - </para> - </note> - <para> - Reads data from a bzcompressed file and creates classes from the bytecodes. - Please note that this function won't execute script body code contained in the bytecode file. - </para> - <example> - <title><function>bcompiler_load</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-load"> + <refnamediv> + <refname>bcompiler_load</refname> + <refpurpose>Reads and creates classes from a bz compressed file</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_load</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <note> + <para> + Please use include or require statements to parse bytecodes, it's more + portable and convenient way than using this function. + </para> + </note> + <para> + Reads data from a bzcompressed file and creates classes from the bytecodes. + Please note that this function won't execute script body code contained in the bytecode file. + </para> + <para> + <example> + <title><function>bcompiler_load</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -35,10 +36,11 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml:1.5 phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml:1.6 --- phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml:1.5 Wed Apr 20 13:53:31 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml Sat Feb 17 18:44:52 2007 @@ -1,30 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-parse-class"> - <refnamediv> - <refname>bcompiler_parse_class</refname> - <refpurpose>Reads the bytecodes of a class and calls back to a user function</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_parse_class</methodname> - <methodparam><type>string</type><parameter>class</parameter></methodparam> - <methodparam><type>string</type><parameter>callback</parameter></methodparam> - </methodsynopsis> - <note> - <para> - This function has been removed from bcompiler and is no - longer available as of bcompiler 0.5. - </para> - </note> - <para> - Reads the bytecodes of a class and calls back to a user function. - </para> - <example> - <title><function>bcompiler_parse_class</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-parse-class"> + <refnamediv> + <refname>bcompiler_parse_class</refname> + <refpurpose>Reads the bytecodes of a class and calls back to a user function</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_parse_class</methodname> + <methodparam><type>string</type><parameter>class</parameter></methodparam> + <methodparam><type>string</type><parameter>callback</parameter></methodparam> + </methodsynopsis> + <note> + <para> + This function has been removed from bcompiler and is no + longer available as of bcompiler 0.5. + </para> + </note> + <para> + Reads the bytecodes of a class and calls back to a user function. + </para> + <para> + <example> + <title><function>bcompiler_parse_class</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -36,10 +37,11 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml:1.4 Sun Jan 2 16:06:53 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml Sat Feb 17 18:44:52 2007 @@ -1,31 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-read"> - <refnamediv> - <refname>bcompiler_read</refname> - <refpurpose>Reads and creates classes from a filehandle</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_read</methodname> - <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <note> - <para> - Please use include or require statements to parse - bytecodes, it's more portable and convenient way than using this function. - </para> - </note> - <para> - Reads data from a open file handle and creates classes from the bytecodes. - Please note that this function won't execute script body code contained in the bytecode file. - </para> - <example> - <title><function>bcompiler_read</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-read"> + <refnamediv> + <refname>bcompiler_read</refname> + <refpurpose>Reads and creates classes from a filehandle</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_read</methodname> + <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <note> + <para> + Please use include or require statements to parse + bytecodes, it's more portable and convenient way than using this function. + </para> + </note> + <para> + Reads data from a open file handle and creates classes from the bytecodes. + Please note that this function won't execute script body code contained in the bytecode file. + </para> + <para> + <example> + <title><function>bcompiler_read</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $fh = fopen("/tmp/example","r"); @@ -35,10 +36,11 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml:1.3 Sat Aug 14 20:44:51 2004 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml Sat Feb 17 18:44:52 2007 @@ -1,29 +1,30 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-write-class"> - <refnamediv> - <refname>bcompiler_write_class</refname> - <refpurpose>Writes an defined class as bytecodes</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_write_class</methodname> - <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> - <methodparam><type>string</type><parameter>className</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>extends</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - This reads the bytecodes from PHP for an existing class, and writes them - to the open file handle, It does not perform dependency checking, so make - sure you write the classes in an order that will not result in an - 'undefined class' occurring when you load it. - </para> - <example> - <title><function>bcompiler_write_class</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-write-class"> + <refnamediv> + <refname>bcompiler_write_class</refname> + <refpurpose>Writes an defined class as bytecodes</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_write_class</methodname> + <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> + <methodparam><type>string</type><parameter>className</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>extends</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + This reads the bytecodes from PHP for an existing class, and writes them + to the open file handle, It does not perform dependency checking, so make + sure you write the classes in an order that will not result in an + 'undefined class' occurring when you load it. + </para> + <para> + <example> + <title><function>bcompiler_write_class</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $fh = fopen("/tmp/example","w"); @@ -37,14 +38,15 @@ ?> ]]> - </programlisting> - </example> - <para> - See also <function>bcompiler_write_header</function>, - and <function>bcompiler_write_footer</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <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: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml:1.1 phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml:1.2 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml:1.1 Fri Aug 13 14:26:44 2004 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml Sat Feb 17 18:44:52 2007 @@ -1,26 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-write-constant"> - <refnamediv> - <refname>bcompiler_write_constant</refname> - <refpurpose>Writes a defined constant as bytecodes</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_write_constant</methodname> - <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> - <methodparam><type>string</type><parameter>constantName</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - This function reads the bytecodes from PHP for an existing constant, and - writes them to the open file handle. - </para> - <example> - <title><function>bcompiler_write_constant</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-write-constant"> + <refnamediv> + <refname>bcompiler_write_constant</refname> + <refpurpose>Writes a defined constant as bytecodes</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_write_constant</methodname> + <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> + <methodparam><type>string</type><parameter>constantName</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + This function reads the bytecodes from PHP for an existing constant, and + writes them to the open file handle. + </para> + <para> + <example> + <title><function>bcompiler_write_constant</function> example</title> + <programlisting role="php"> <![CDATA[ <?php define("MODULE_MAX", 30); @@ -33,14 +34,15 @@ ?> ]]> - </programlisting> - </example> - <para> - See also <function>bcompiler_write_header</function>, - and <function>bcompiler_write_footer</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <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: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml:1.3 Wed Apr 20 14:05:08 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml Sat Feb 17 18:44:52 2007 @@ -1,42 +1,43 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-write-exe-footer"> - <refnamediv> - <refname>bcompiler_write_exe_footer</refname> - <refpurpose>Writes the start pos, and sig to the end of a exe type file</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_write_exe_footer</methodname> - <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> - <methodparam><type>int</type><parameter>startpos</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - An EXE (or self executable) file consists of 3 parts, - </para> - <para> - <simplelist> - <member> - The stub (executable code, e.g. a compiled C program) that loads PHP - interpreter, bcompiler extension, stored Bytecodes and initiates a call - for the specified function (e.g. main) or class method (e.g. main::main) - </member> - <member>The Bytecodes (uncompressed only for the moment)</member> - <member>The bcompiler EXE footer</member> - </simplelist> - The <parameter>startpos</parameter> is the file position at - which the Bytecodes start, and can be obtained using ftell($fh). - </para> - <para> - To obtain a suitable stub you can compile php_embed-based stub phpe.c - located in the examples/embed directory on bcompiler's CVS. - </para> - <example> - <title><function>bcompiler_write_footer</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-write-exe-footer"> + <refnamediv> + <refname>bcompiler_write_exe_footer</refname> + <refpurpose>Writes the start pos, and sig to the end of a exe type file</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_write_exe_footer</methodname> + <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> + <methodparam><type>int</type><parameter>startpos</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + An EXE (or self executable) file consists of 3 parts, + </para> + <para> + <simplelist> + <member> + The stub (executable code, e.g. a compiled C program) that loads PHP + interpreter, bcompiler extension, stored Bytecodes and initiates a call + for the specified function (e.g. main) or class method (e.g. main::main) + </member> + <member>The Bytecodes (uncompressed only for the moment)</member> + <member>The bcompiler EXE footer</member> + </simplelist> + The <parameter>startpos</parameter> is the file position at + which the Bytecodes start, and can be obtained using ftell($fh). + </para> + <para> + To obtain a suitable stub you can compile php_embed-based stub phpe.c + located in the examples/embed directory on bcompiler's CVS. + </para> + <para> + <example> + <title><function>bcompiler_write_footer</function> example</title> + <programlisting role="php"> <![CDATA[ <?php /* creating the output file (example.exe) */ @@ -57,15 +58,16 @@ fclose($fh); ?> ]]> - </programlisting> - </example> - <para> - See also <function>bcompiler_write_header</function>, - <function>bcompiler_write_class</function>, and - <function>bcompiler_write_footer</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>bcompiler_write_header</function>, + <function>bcompiler_write_class</function>, and + <function>bcompiler_write_footer</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml:1.3 Mon Mar 28 20:30:34 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml Sat Feb 17 18:44:52 2007 @@ -1,65 +1,67 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> - <refentry id="function.bcompiler-write-file"> - <refnamediv> - <refname>bcompiler_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"); -bcompiler_write_header($fh); -bcompiler_write_file($fh, "example.php"); -bcompiler_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 ---> +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- $Revision: 1.4 $ --> +<refentry id="function.bcompiler-write-file"> + <refnamediv> + <refname>bcompiler_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> + <para> + <example> + <title><function>bcompiler_write_file</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$fh = fopen("example.phb", "w"); +bcompiler_write_header($fh); +bcompiler_write_file($fh, "example.php"); +bcompiler_write_footer($fh); +fclose($fh); +/* the following should be equivalent: +include "example.php"; + and +include "example.phb"; +*/ +?> +]]> + </programlisting> + </example> + </para> + <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 +--> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml:1.3 Wed Apr 20 14:05:08 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml Sat Feb 17 18:44:52 2007 @@ -1,24 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-write-footer"> - <refnamediv> - <refname>bcompiler_write_footer</refname> - <refpurpose>Writes the single character \x00 to indicate End of compiled data</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_write_footer</methodname> - <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - Writes the single character \x00 to indicate End of compiled data. - </para> - <example> - <title><function>bcompiler_write_footer</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-write-footer"> + <refnamediv> + <refname>bcompiler_write_footer</refname> + <refpurpose>Writes the single character \x00 to indicate End of compiled data</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_write_footer</methodname> + <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + Writes the single character \x00 to indicate End of compiled data. + </para> + <para> + <example> + <title><function>bcompiler_write_footer</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $fh = fopen("/tmp/example","w"); @@ -30,14 +31,15 @@ ?> ]]> - </programlisting> - </example> - <para> - See also <function>bcompiler_write_header</function>, and - <function>bcompiler_write_header</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>bcompiler_write_header</function>, and + <function>bcompiler_write_header</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml:1.2 phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml:1.3 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml:1.2 Wed Apr 20 13:53:31 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml Sat Feb 17 18:44:52 2007 @@ -1,28 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-write-function"> - <refnamediv> - <refname>bcompiler_write_function</refname> - <refpurpose>Writes an defined function as bytecodes</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_write_function</methodname> - <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> - <methodparam><type>string</type><parameter>functionName</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - This reads the bytecodes from PHP for an existing function, and writes - them to the open file handle. Order is not important, (eg. if function b - uses function a, and you compile it like the example below, it will - work perfectly OK). - </para> - <example> - <title><function>bcompiler_write_function</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-write-function"> + <refnamediv> + <refname>bcompiler_write_function</refname> + <refpurpose>Writes an defined function as bytecodes</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_write_function</methodname> + <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> + <methodparam><type>string</type><parameter>functionName</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + This reads the bytecodes from PHP for an existing function, and writes + them to the open file handle. Order is not important, (eg. if function b + uses function a, and you compile it like the example below, it will + work perfectly OK). + </para> + <para> + <example> + <title><function>bcompiler_write_function</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $fh = fopen("/tmp/example","w"); @@ -34,14 +35,15 @@ ?> ]]> - </programlisting> - </example> - <para> - See also <function>bcompiler_write_header</function>, and - <function>bcompiler_write_footer</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <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: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml:1.1 phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml:1.2 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml:1.1 Fri Aug 13 14:26:44 2004 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml Sat Feb 17 18:44:52 2007 @@ -1,27 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-write-functions-from-file"> - <refnamediv> - <refname>bcompiler_write_functions_from_file</refname> - <refpurpose>Writes all functions defined in a file as bytecodes</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_write_functions_from_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 searches for all functions declared in the given file, and - writes their correspondent bytecodes to the open file handle. Always - remember to include/require the file you intend to compile. - </para> - <example> - <title><function>bcompiler_write_functions_from_file</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-write-functions-from-file"> + <refnamediv> + <refname>bcompiler_write_functions_from_file</refname> + <refpurpose>Writes all functions defined in a file as bytecodes</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_write_functions_from_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 searches for all functions declared in the given file, and + writes their correspondent bytecodes to the open file handle. Always + remember to include/require the file you intend to compile. + </para> + <para> + <example> + <title><function>bcompiler_write_functions_from_file</function> example</title> + <programlisting role="php"> <![CDATA[ <?php require('module.php'); @@ -34,14 +35,15 @@ ?> ]]> - </programlisting> - </example> - <para> - See also <function>bcompiler_write_header</function>, and - <function>bcompiler_write_footer</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <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: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml:1.3 Sun Jan 2 16:08:26 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml Sat Feb 17 18:44:52 2007 @@ -1,27 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-write-header"> - <refnamediv> - <refname>bcompiler_write_header</refname> - <refpurpose>Writes the bcompiler header</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_write_header</methodname> - <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>write_ver</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - Writes the header part of a bcompiler file. - Optional second parameter can be used to write bytecode in a previously - used format, so that you can use it with older versions of bcompiler. - </para> - <example> - <title><function>bcompiler_write_header</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-write-header"> + <refnamediv> + <refname>bcompiler_write_header</refname> + <refpurpose>Writes the bcompiler header</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_write_header</methodname> + <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>write_ver</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + Writes the header part of a bcompiler file. + Optional second parameter can be used to write bytecode in a previously + used format, so that you can use it with older versions of bcompiler. + </para> + <para> + <example> + <title><function>bcompiler_write_header</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $fh = fopen("/tmp/example","w"); @@ -32,16 +33,17 @@ ?> ]]> - </programlisting> - </example> - <para> - See also <function>bcompiler_write_file</function>, - <function>bcompiler_write_class</function>, - <function>bcompiler_write_function</function>, and - <function>bcompiler_write_footer</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>bcompiler_write_file</function>, + <function>bcompiler_write_class</function>, + <function>bcompiler_write_function</function>, and + <function>bcompiler_write_footer</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables:
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml:1.3 Wed Apr 20 13:53:31 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-load-exe.xml Sat Feb 17 18:44:52 2007 @@ -1,24 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-load-exe"> - <refnamediv> - <refname>bcompiler_load_exe</refname> - <refpurpose>Reads and creates classes from a bcompiler exe file</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_load_exe</methodname> - <methodparam><type>string</type><parameter>filename</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - Reads data from a bcompiler exe file and creates classes from the bytecodes. - </para> - <example> - <title><function>bcompiler_load</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-load-exe"> + <refnamediv> + <refname>bcompiler_load_exe</refname> + <refpurpose>Reads and creates classes from a bcompiler exe file</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_load_exe</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + Reads data from a bcompiler exe file and creates classes from the bytecodes. + </para> + <para> + <example> + <title><function>bcompiler_load</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -27,10 +28,11 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml:1.3 Sun Jan 2 16:06:53 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-load.xml Sat Feb 17 18:44:52 2007 @@ -1,31 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-load"> - <refnamediv> - <refname>bcompiler_load</refname> - <refpurpose>Reads and creates classes from a bz compressed file</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_load</methodname> - <methodparam><type>string</type><parameter>filename</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <note> - <para> - Please use include or require statements to parse bytecodes, it's more - portable and convenient way than using this function. - </para> - </note> - <para> - Reads data from a bzcompressed file and creates classes from the bytecodes. - Please note that this function won't execute script body code contained in the bytecode file. - </para> - <example> - <title><function>bcompiler_load</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-load"> + <refnamediv> + <refname>bcompiler_load</refname> + <refpurpose>Reads and creates classes from a bz compressed file</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_load</methodname> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <note> + <para> + Please use include or require statements to parse bytecodes, it's more + portable and convenient way than using this function. + </para> + </note> + <para> + Reads data from a bzcompressed file and creates classes from the bytecodes. + Please note that this function won't execute script body code contained in the bytecode file. + </para> + <para> + <example> + <title><function>bcompiler_load</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -35,10 +36,11 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml:1.5 phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml:1.6 --- phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml:1.5 Wed Apr 20 13:53:31 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-parse-class.xml Sat Feb 17 18:44:52 2007 @@ -1,30 +1,31 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> +<!-- $Revision: 1.6 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-parse-class"> - <refnamediv> - <refname>bcompiler_parse_class</refname> - <refpurpose>Reads the bytecodes of a class and calls back to a user function</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_parse_class</methodname> - <methodparam><type>string</type><parameter>class</parameter></methodparam> - <methodparam><type>string</type><parameter>callback</parameter></methodparam> - </methodsynopsis> - <note> - <para> - This function has been removed from bcompiler and is no - longer available as of bcompiler 0.5. - </para> - </note> - <para> - Reads the bytecodes of a class and calls back to a user function. - </para> - <example> - <title><function>bcompiler_parse_class</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-parse-class"> + <refnamediv> + <refname>bcompiler_parse_class</refname> + <refpurpose>Reads the bytecodes of a class and calls back to a user function</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_parse_class</methodname> + <methodparam><type>string</type><parameter>class</parameter></methodparam> + <methodparam><type>string</type><parameter>callback</parameter></methodparam> + </methodsynopsis> + <note> + <para> + This function has been removed from bcompiler and is no + longer available as of bcompiler 0.5. + </para> + </note> + <para> + Reads the bytecodes of a class and calls back to a user function. + </para> + <para> + <example> + <title><function>bcompiler_parse_class</function> example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -36,10 +37,11 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml:1.4 phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml:1.5 --- phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml:1.4 Sun Jan 2 16:06:53 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-read.xml Sat Feb 17 18:44:52 2007 @@ -1,31 +1,32 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-read"> - <refnamediv> - <refname>bcompiler_read</refname> - <refpurpose>Reads and creates classes from a filehandle</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_read</methodname> - <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <note> - <para> - Please use include or require statements to parse - bytecodes, it's more portable and convenient way than using this function. - </para> - </note> - <para> - Reads data from a open file handle and creates classes from the bytecodes. - Please note that this function won't execute script body code contained in the bytecode file. - </para> - <example> - <title><function>bcompiler_read</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-read"> + <refnamediv> + <refname>bcompiler_read</refname> + <refpurpose>Reads and creates classes from a filehandle</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_read</methodname> + <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <note> + <para> + Please use include or require statements to parse + bytecodes, it's more portable and convenient way than using this function. + </para> + </note> + <para> + Reads data from a open file handle and creates classes from the bytecodes. + Please note that this function won't execute script body code contained in the bytecode file. + </para> + <para> + <example> + <title><function>bcompiler_read</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $fh = fopen("/tmp/example","r"); @@ -35,10 +36,11 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml:1.3 Sat Aug 14 20:44:51 2004 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-class.xml Sat Feb 17 18:44:52 2007 @@ -1,29 +1,30 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-write-class"> - <refnamediv> - <refname>bcompiler_write_class</refname> - <refpurpose>Writes an defined class as bytecodes</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_write_class</methodname> - <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> - <methodparam><type>string</type><parameter>className</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>extends</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - This reads the bytecodes from PHP for an existing class, and writes them - to the open file handle, It does not perform dependency checking, so make - sure you write the classes in an order that will not result in an - 'undefined class' occurring when you load it. - </para> - <example> - <title><function>bcompiler_write_class</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-write-class"> + <refnamediv> + <refname>bcompiler_write_class</refname> + <refpurpose>Writes an defined class as bytecodes</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_write_class</methodname> + <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> + <methodparam><type>string</type><parameter>className</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>extends</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + This reads the bytecodes from PHP for an existing class, and writes them + to the open file handle, It does not perform dependency checking, so make + sure you write the classes in an order that will not result in an + 'undefined class' occurring when you load it. + </para> + <para> + <example> + <title><function>bcompiler_write_class</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $fh = fopen("/tmp/example","w"); @@ -37,14 +38,15 @@ ?> ]]> - </programlisting> - </example> - <para> - See also <function>bcompiler_write_header</function>, - and <function>bcompiler_write_footer</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <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: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml:1.1 phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml:1.2 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml:1.1 Fri Aug 13 14:26:44 2004 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-constant.xml Sat Feb 17 18:44:52 2007 @@ -1,26 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-write-constant"> - <refnamediv> - <refname>bcompiler_write_constant</refname> - <refpurpose>Writes a defined constant as bytecodes</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_write_constant</methodname> - <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> - <methodparam><type>string</type><parameter>constantName</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - This function reads the bytecodes from PHP for an existing constant, and - writes them to the open file handle. - </para> - <example> - <title><function>bcompiler_write_constant</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-write-constant"> + <refnamediv> + <refname>bcompiler_write_constant</refname> + <refpurpose>Writes a defined constant as bytecodes</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_write_constant</methodname> + <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> + <methodparam><type>string</type><parameter>constantName</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + This function reads the bytecodes from PHP for an existing constant, and + writes them to the open file handle. + </para> + <para> + <example> + <title><function>bcompiler_write_constant</function> example</title> + <programlisting role="php"> <![CDATA[ <?php define("MODULE_MAX", 30); @@ -33,14 +34,15 @@ ?> ]]> - </programlisting> - </example> - <para> - See also <function>bcompiler_write_header</function>, - and <function>bcompiler_write_footer</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <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: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml:1.3 Wed Apr 20 14:05:08 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-exe-footer.xml Sat Feb 17 18:44:52 2007 @@ -1,42 +1,43 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-write-exe-footer"> - <refnamediv> - <refname>bcompiler_write_exe_footer</refname> - <refpurpose>Writes the start pos, and sig to the end of a exe type file</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_write_exe_footer</methodname> - <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> - <methodparam><type>int</type><parameter>startpos</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - An EXE (or self executable) file consists of 3 parts, - </para> - <para> - <simplelist> - <member> - The stub (executable code, e.g. a compiled C program) that loads PHP - interpreter, bcompiler extension, stored Bytecodes and initiates a call - for the specified function (e.g. main) or class method (e.g. main::main) - </member> - <member>The Bytecodes (uncompressed only for the moment)</member> - <member>The bcompiler EXE footer</member> - </simplelist> - The <parameter>startpos</parameter> is the file position at - which the Bytecodes start, and can be obtained using ftell($fh). - </para> - <para> - To obtain a suitable stub you can compile php_embed-based stub phpe.c - located in the examples/embed directory on bcompiler's CVS. - </para> - <example> - <title><function>bcompiler_write_footer</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-write-exe-footer"> + <refnamediv> + <refname>bcompiler_write_exe_footer</refname> + <refpurpose>Writes the start pos, and sig to the end of a exe type file</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_write_exe_footer</methodname> + <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> + <methodparam><type>int</type><parameter>startpos</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + An EXE (or self executable) file consists of 3 parts, + </para> + <para> + <simplelist> + <member> + The stub (executable code, e.g. a compiled C program) that loads PHP + interpreter, bcompiler extension, stored Bytecodes and initiates a call + for the specified function (e.g. main) or class method (e.g. main::main) + </member> + <member>The Bytecodes (uncompressed only for the moment)</member> + <member>The bcompiler EXE footer</member> + </simplelist> + The <parameter>startpos</parameter> is the file position at + which the Bytecodes start, and can be obtained using ftell($fh). + </para> + <para> + To obtain a suitable stub you can compile php_embed-based stub phpe.c + located in the examples/embed directory on bcompiler's CVS. + </para> + <para> + <example> + <title><function>bcompiler_write_footer</function> example</title> + <programlisting role="php"> <![CDATA[ <?php /* creating the output file (example.exe) */ @@ -57,15 +58,16 @@ fclose($fh); ?> ]]> - </programlisting> - </example> - <para> - See also <function>bcompiler_write_header</function>, - <function>bcompiler_write_class</function>, and - <function>bcompiler_write_footer</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>bcompiler_write_header</function>, + <function>bcompiler_write_class</function>, and + <function>bcompiler_write_footer</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml:1.3 Mon Mar 28 20:30:34 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-file.xml Sat Feb 17 18:44:52 2007 @@ -1,65 +1,67 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> - <refentry id="function.bcompiler-write-file"> - <refnamediv> - <refname>bcompiler_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"); -bcompiler_write_header($fh); -bcompiler_write_file($fh, "example.php"); -bcompiler_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 ---> +<?xml version="1.0" encoding="iso-8859-1"?> +<!-- $Revision: 1.4 $ --> +<refentry id="function.bcompiler-write-file"> + <refnamediv> + <refname>bcompiler_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> + <para> + <example> + <title><function>bcompiler_write_file</function> example</title> + <programlisting role="php"> +<![CDATA[ +<?php +$fh = fopen("example.phb", "w"); +bcompiler_write_header($fh); +bcompiler_write_file($fh, "example.php"); +bcompiler_write_footer($fh); +fclose($fh); +/* the following should be equivalent: +include "example.php"; + and +include "example.phb"; +*/ +?> +]]> + </programlisting> + </example> + </para> + <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 +--> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml:1.3 Wed Apr 20 14:05:08 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-footer.xml Sat Feb 17 18:44:52 2007 @@ -1,24 +1,25 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-write-footer"> - <refnamediv> - <refname>bcompiler_write_footer</refname> - <refpurpose>Writes the single character \x00 to indicate End of compiled data</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_write_footer</methodname> - <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - Writes the single character \x00 to indicate End of compiled data. - </para> - <example> - <title><function>bcompiler_write_footer</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-write-footer"> + <refnamediv> + <refname>bcompiler_write_footer</refname> + <refpurpose>Writes the single character \x00 to indicate End of compiled data</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_write_footer</methodname> + <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + Writes the single character \x00 to indicate End of compiled data. + </para> + <para> + <example> + <title><function>bcompiler_write_footer</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $fh = fopen("/tmp/example","w"); @@ -30,14 +31,15 @@ ?> ]]> - </programlisting> - </example> - <para> - See also <function>bcompiler_write_header</function>, and - <function>bcompiler_write_header</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>bcompiler_write_header</function>, and + <function>bcompiler_write_header</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml:1.2 phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml:1.3 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml:1.2 Wed Apr 20 13:53:31 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-function.xml Sat Feb 17 18:44:52 2007 @@ -1,28 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-write-function"> - <refnamediv> - <refname>bcompiler_write_function</refname> - <refpurpose>Writes an defined function as bytecodes</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_write_function</methodname> - <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> - <methodparam><type>string</type><parameter>functionName</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - This reads the bytecodes from PHP for an existing function, and writes - them to the open file handle. Order is not important, (eg. if function b - uses function a, and you compile it like the example below, it will - work perfectly OK). - </para> - <example> - <title><function>bcompiler_write_function</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-write-function"> + <refnamediv> + <refname>bcompiler_write_function</refname> + <refpurpose>Writes an defined function as bytecodes</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_write_function</methodname> + <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> + <methodparam><type>string</type><parameter>functionName</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + This reads the bytecodes from PHP for an existing function, and writes + them to the open file handle. Order is not important, (eg. if function b + uses function a, and you compile it like the example below, it will + work perfectly OK). + </para> + <para> + <example> + <title><function>bcompiler_write_function</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $fh = fopen("/tmp/example","w"); @@ -34,14 +35,15 @@ ?> ]]> - </programlisting> - </example> - <para> - See also <function>bcompiler_write_header</function>, and - <function>bcompiler_write_footer</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <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: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml:1.1 phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml:1.2 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml:1.1 Fri Aug 13 14:26:44 2004 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-functions-from-file.xml Sat Feb 17 18:44:52 2007 @@ -1,27 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-write-functions-from-file"> - <refnamediv> - <refname>bcompiler_write_functions_from_file</refname> - <refpurpose>Writes all functions defined in a file as bytecodes</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_write_functions_from_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 searches for all functions declared in the given file, and - writes their correspondent bytecodes to the open file handle. Always - remember to include/require the file you intend to compile. - </para> - <example> - <title><function>bcompiler_write_functions_from_file</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-write-functions-from-file"> + <refnamediv> + <refname>bcompiler_write_functions_from_file</refname> + <refpurpose>Writes all functions defined in a file as bytecodes</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_write_functions_from_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 searches for all functions declared in the given file, and + writes their correspondent bytecodes to the open file handle. Always + remember to include/require the file you intend to compile. + </para> + <para> + <example> + <title><function>bcompiler_write_functions_from_file</function> example</title> + <programlisting role="php"> <![CDATA[ <?php require('module.php'); @@ -34,14 +35,15 @@ ?> ]]> - </programlisting> - </example> - <para> - See also <function>bcompiler_write_header</function>, and - <function>bcompiler_write_footer</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <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: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml diff -u phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml:1.3 phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml:1.4 --- phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml:1.3 Sun Jan 2 16:08:26 2005 +++ phpdoc/en/reference/bcompiler/functions/bcompiler-write-header.xml Sat Feb 17 18:44:52 2007 @@ -1,27 +1,28 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <!-- splitted from ./en/functions/bcompiler.xml, last change in rev 1.5 --> - <refentry id="function.bcompiler-write-header"> - <refnamediv> - <refname>bcompiler_write_header</refname> - <refpurpose>Writes the bcompiler header</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>bcompiler_write_header</methodname> - <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>write_ver</parameter></methodparam> - </methodsynopsis> - &warn.experimental.func; - <para> - Writes the header part of a bcompiler file. - Optional second parameter can be used to write bytecode in a previously - used format, so that you can use it with older versions of bcompiler. - </para> - <example> - <title><function>bcompiler_write_header</function> example</title> - <programlisting role="php"> +<refentry id="function.bcompiler-write-header"> + <refnamediv> + <refname>bcompiler_write_header</refname> + <refpurpose>Writes the bcompiler header</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>bcompiler_write_header</methodname> + <methodparam><type>resource</type><parameter>filehandle</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>write_ver</parameter></methodparam> + </methodsynopsis> + &warn.experimental.func; + <para> + Writes the header part of a bcompiler file. + Optional second parameter can be used to write bytecode in a previously + used format, so that you can use it with older versions of bcompiler. + </para> + <para> + <example> + <title><function>bcompiler_write_header</function> example</title> + <programlisting role="php"> <![CDATA[ <?php $fh = fopen("/tmp/example","w"); @@ -32,16 +33,17 @@ ?> ]]> - </programlisting> - </example> - <para> - See also <function>bcompiler_write_file</function>, - <function>bcompiler_write_class</function>, - <function>bcompiler_write_function</function>, and - <function>bcompiler_write_footer</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See also <function>bcompiler_write_file</function>, + <function>bcompiler_write_class</function>, + <function>bcompiler_write_function</function>, and + <function>bcompiler_write_footer</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: