halt-compiler.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4411b371d0ba1d5faee06177a473f928716c2921 Maintainer: hholzgra  Status: ready -->
<!-- Reviewed: yes Maintainer: samesch -->
<refentry xml:id="function.halt-compiler" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>__halt_compiler</refname>
  <refpurpose>Beendet die Kompilerausführung</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>__halt_compiler</methodname>
   <void/>
  </methodsynopsis>
  <para>
   Beendet die Kompilerausführung. Dies kann sinnvoll sein, wenn Daten
   in PHP-Skripte eingebettet sind, wie &zb; in Installationsdateien.
  </para>
  <para>
   Die Byteposition, an der die Daten beginnen, kann über die Konstante
   <constant>__COMPILER_HALT_OFFSET__</constant> ermittelt werden, die
   nur definiert ist, wenn die Funktion <function>__halt_compiler</function>
   in der Datei benutzt wird.
  </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>Ein <function>__halt_compiler</function>-Beispiel</title>
    <programlisting role="php">
<![CDATA[
<?php

// Datei öffnen
$fp = fopen(__FILE__, 'r');

// Auf den Anfang der Daten positionieren
fseek($fp, __COMPILER_HALT_OFFSET__);

// und diese ausgeben
var_dump(stream_get_contents($fp));

// hier Kompilation beenden
__halt_compiler(); ab hier die eigentlichen Daten (z.B. tar, gz, PHP, etc.)
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="notes">
  &reftitle.notes;
  <note>
   <para>
    <function>__halt_compiler</function> kann nur auf der höchsten
    Ausführungsebene und nicht innerhalb anderer Funktionen oder
    Methoden benutzt werden.
   </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
-->