mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
WS: prepare for new doc style
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@230089 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Mehdi Achour
parent
cc9fef97f1
commit
3f247906f8
12 changed files with 428 additions and 404 deletions
|
|
@ -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 @@ print_r(get_defined_classes());
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
|
|
|
|||
|
|
@ -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 @@ print_r(get_defined_classes());
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
|
|
|
|||
|
|
@ -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 @@ bcompiler_parse_class("DB","readByteCodes");
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
|
|
|
|||
|
|
@ -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 @@ print_r(get_defined_classes());
|
|||
|
||||
?>
|
||||
]]>
|
||||
</programlisting>
|
||||
</example>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
</programlisting>
|
||||
</example>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<!-- Keep this comment at the end of the file
|
||||
Local variables:
|
||||
|
|
|
|||
|
|
@ -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 @@ fclose($fh);
|
|||
|
||||
?>
|
||||
]]>
|
||||
</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:
|
||||
|
|
|
|||
|
|
@ -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 @@ fclose($fh);
|
|||
|
||||
?>
|
||||
]]>
|
||||
</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:
|
||||
|
|
|
|||
|
|
@ -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 @@ bcompiler_write_exe_footer($fh, $startpos);
|
|||
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:
|
||||
|
|
|
|||
|
|
@ -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
|
||||
-->
|
||||
|
|
|
|||
|
|
@ -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 @@ fclose($fh);
|
|||
|
||||
?>
|
||||
]]>
|
||||
</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:
|
||||
|
|
|
|||
|
|
@ -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 @@ fclose($fh);
|
|||
|
||||
?>
|
||||
]]>
|
||||
</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:
|
||||
|
|
|
|||
|
|
@ -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 @@ fclose($fh);
|
|||
|
||||
?>
|
||||
]]>
|
||||
</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:
|
||||
|
|
|
|||
|
|
@ -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 @@ fclose($fh);
|
|||
|
||||
?>
|
||||
]]>
|
||||
</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:
|
||||
|
|
|
|||
Loading…
Reference in a new issue