mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-19 18:38:55 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
128 lines
3.1 KiB
XML
128 lines
3.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.bcompiler-write-class" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>bcompiler_write_class</refname>
|
|
<refpurpose>Writes an defined class as bytecodes</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<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>
|
|
<para>
|
|
Reads the bytecodes from PHP for an existing class, and writes them to the
|
|
open file handle.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>filehandle</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A file handle as returned by <function>fopen</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>className</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The class name, as a string.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>extends</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>bcompiler_write_class</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$fh = fopen("/tmp/example","w");
|
|
bcompiler_write_header($fh);
|
|
bcompiler_write_class($fh,"DB");
|
|
// you must write DB_common before DB_mysql, as DB_mysql extends DB_common.
|
|
bcompiler_write_class($fh,"DB_common");
|
|
bcompiler_write_class($fh,"DB_mysql");
|
|
bcompiler_write_footer($fh);
|
|
fclose($fh);
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
&warn.experimental.func;
|
|
<note>
|
|
<para>
|
|
This function does not perform dependency checking, so make sure you
|
|
write the classes in an order that will not result in an
|
|
<literal>undefined class</literal> error occurring when you load it.
|
|
</para>
|
|
</note>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>bcompiler_write_header</function></member>
|
|
<member><function>bcompiler_write_footer</function></member>
|
|
</simplelist>
|
|
</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:"~/.phpdoc/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
|
|
-->
|