php-doc-en/reference/misc/functions/halt-compiler.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<refentry id="function.halt-compiler">
 <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>
   This function halts the execution of the compiler. This can be useful to
   embed data in PHP scripts, like the installation files.
  </para>
  <note>
   <para>
    <function>__halt_compiler</function> can only be used from the outermost
    scope.
   </para>
  </note>
 </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
// plus the line-feed (that will depend on the file format/OS)
fseek($fp, __COMPILER_HALT_OFFSET__ + strlen(PHP_EOL));

// and output it
var_dump(stream_get_contents($fp));

// the end of the script execution
__halt_compiler();
the instalation data (eg. tar, gz, etc..)
]]>
    </programlisting>
   </example>
  </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
-->