mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 08:58:56 +00:00
97 lines
2.2 KiB
XML
97 lines
2.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.halt-compiler" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>__halt_compiler</refname>
|
|
<refpurpose>
|
|
Halts the compiler execution
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>void</type><methodname>__halt_compiler</methodname>
|
|
<void/>
|
|
</methodsynopsis>
|
|
<para>
|
|
Halts the execution of the compiler. This can be useful to embed data in
|
|
PHP scripts, like the installation files.
|
|
</para>
|
|
<para>
|
|
Byte position of the data start can be determined by the
|
|
<constant>__COMPILER_HALT_OFFSET__</constant> constant which is defined
|
|
only if there is a <function>__halt_compiler</function> presented in the
|
|
file.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
&no.function.parameters;
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.void;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>A <function>__halt_compiler</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
// open this file
|
|
$fp = fopen(__FILE__, 'r');
|
|
|
|
// seek file pointer to data
|
|
fseek($fp, __COMPILER_HALT_OFFSET__);
|
|
|
|
// and output it
|
|
var_dump(stream_get_contents($fp));
|
|
|
|
// the end of the script execution
|
|
__halt_compiler(); the installation data (eg. tar, gz, PHP, etc.)
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
<note>
|
|
<para>
|
|
<function>__halt_compiler</function> can only be used from the outermost
|
|
scope.
|
|
</para>
|
|
</note>
|
|
</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
|
|
-->
|